Retrologic Systems Retrologic Systems Retrologic Systems
Online Jargon File
  RetroGuard  |  RetroCapture  |  Contracting  |  Site Map  |  Contact

boxed comments - The Jargon File

0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Jargon On Your Website    Random Entry (Alt-R)RSS Feed - Random Jargon
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.


 
 Copyright © 1998-2006 Retrologic Systems. retroguard | retrocapture | contracting | site map | contact
 All rights reserved. site terms | privacy policy