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

Doc-O-Matic extracts documentation for source code symbols from comments stored in source code. Comments can be placed above or below the symbol you are documenting or any other location in the source code. Doc-O-Matic associates comments with symbols that follow comments by default. The next sections describe, where Doc-O-Matic finds comments in your source code:

  • Associate comment blocks with following symbol: Explains where you must place your comments, when you have turned on this option.
  • Associate comment blocks with previous symbol: Explains where you must place your comments, when you have turned on this option.
  • Ignoring Comments and Using Tokens: Ignoring Comments: Explains how you can instruct Doc-O-Matic to use certain comments and not to use others or not use any source comments.
  • The Comment Block example, shows what a comment block is, and which information is extracted from source files as comment.
  • The Comment Distance example, shows how far away you can insert a comment block from a symbol.
  • The Specifying a Symbol example, shows how you can instruct Doc-O-Matic to use a certain documentation comment for a specific symbol.

Doc-O-Matic associates comments at the very beginning (there must not be a single space between the beginning of the file and the first comment) of a file with the file and not with the following symbol. On the [General Settings] > Documentation > Comment Finding > File Comments page you can turn off this feature.

Comment Finding, Tokens

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