Boxed comments

From JargonWiki

The Jargon File Parts of this article are based on the Jargon File, v. 4.4.7, a public domain document of hacker jargon.

boxed comments

Usage: n. Antonym(s): winged comments

boxed comments: n.

Comments (explanatory notes attached to program instructions) that occupy several lines by themselves; so called because in assembler and C code they are often surrounded by a box in a style something like this:

/*************************************************
 *
 * This is a boxed comment in C style
 * 
 *************************************************/

Common variants of this style omit the asterisks in column 2 or add a matching row of asterisks closing the right side of the box. The sparest variant omits all but the comment delimiters themselves; the `box' is implied. Oppose [[winged comments]].

== Sources ==
{{External Source|http://catb.org/jargon/html/B/boxed-comments.html|boxed comments| in [[Source:Jargon_File|The Jargon File]], version 4.4.7.}}

{{Public Domain}}

[[Category:Hacker|{{PAGENAME}}]]