boxed comments

You are here: irt.org | FOLDOC | boxed comments

<programming> Comments that occupy several lines by themselves; so called because in assembler and C code they are often surrounded by a box in a style similar to 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.

Opposite of winged comments.

[Jargon File]

(1997-07-21)

Nearby terms: Bourne shell « boustrophedonic « box « boxed comments » boxen » Boxer » boxology

FOLDOC, Topics, 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, ?, ALL