Example: Comments Preceding Symbols

You are here: More Information

Special Tasks

Technical Reference

File and Parsing Options

Comments Preceding Symbols

Doc-O-Matic 10

Example: Comments Preceding Symbols

Doc-O-Matic associates the comment with the symbol that follows, as in the following example.

// The Sort function sorts the list.
bool MyList::Sort(int Options)
{
  [...]
}

Doc-O-Matic handles all comment styles equally, so the following comments result in identical documentation texts:

/* The Sort function sorts the list. */
// The Sort function sorts the list.