Information Technology Reference
In-Depth Information
Summary of Comment Types
Inline comments
are sections of text that are ignored by the compiler but are included in the
code to document it. Programmers insert comments into their code to explain and document
it. Table 2-4 gives a summary of the comment types.
Table 2-4.
Comment Types
Type
Start
End
Description
//
Single-line
The text from the beginning marker to the end of the current
line is ignored by the compiler.
/*
*/
Delimited
The text between the start and end markers is ignored by the
compiler.
///
Documentation
Comments of this type contain XML text that is meant to be
extracted by a tool to produce program documentation.
d51b07054b56b5c0852aa55b196128ed
