You are here: More Information > Special Tasks
Special Tasks
Technical Reference
> Comment Finding
File and Parsing Options
Comment Finding
Close
Doc-O-Matic 10
Specifying a Symbol

The following example shows how you can associate a comment with a specific symbol. To ensure that a comment is processed as documentation for a specific symbol, type the Token, and then type (without a white space) the fully qualified topic ID. The following example shows comments for the method Sort in class List:

(C++) //@@List::Sort // The Sort function sorts the list.

Note: The symbol qualifier ("::" or ".") depends on the source code language of the symbol you are documenting.
 

This way you can insert comments for a symbol in another location in the same source file or store it in another file.

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.