JargonFile/original/html/B/boxed-comments.html
2014-03-27 18:54:56 +00:00

16 lines
2.3 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>boxed comments</title><link rel="stylesheet" href="../../jargon.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.61.0"/><link rel="home" href="../index.html" title="The Jargon File"/><link rel="up" href="../B.html" title="B"/><link rel="previous" href="box.html" title="box"/><link rel="next" href="boxen.html" title="boxen"/></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">boxed comments</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="box.html">Prev</a> </td><th width="60%" align="center">B</th><td width="20%" align="right"> <a accesskey="n" href="boxen.html">Next</a></td></tr></table><hr/></div><dt><a id="boxed-comments"/><dt xmlns="" id="boxed-comments"><b>boxed comments</b>: <span xmlns="http://www.w3.org/1999/xhtml" class="grammar">n.</span></dt></dt><dd><p> 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:
</p><table border="0" bgcolor="#E0E0E0"><tr><td><pre class="programlisting">
/*************************************************
*
* This is a boxed comment in C style
*
*************************************************/
</pre></td></tr></table><p>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
&#8216;box&#8217; is implied. Oppose
<a href="../W/winged-comments.html"><i class="glossterm">winged comments</i></a>.</p></dd><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="box.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="../B.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="boxen.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">box </td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top"> boxen</td></tr></table></div></body></html>