You are here: More Information > Technical Reference
Special Tasks
Technical Reference
> Coding and Comment Standards
Close
Doc-O-Matic 10
Coding and Comment Standards

Doc-O-Matic parses any source files ANSI as well as Unicode and extracts all existing comments. It is not necessary to change your source code or your comment style. However, there are some programming and commenting standards you have to follow so that Doc-O-Matic can correctly parse your source code.

Source code

Every symbol must have a unique name. For example, if you use enums and functions with the same name, you can hide one of the symbols from Doc-O-Matic using the code skip feature. 

Symbol names must be identical, every time they are used. If they are not, Doc-O-Matic does not recognize them and can not concatenate comments in different locations. If you code in Delphi/Pascal make sure your symbol names are case sensitive. If you code in C/C++ make sure that you insert spaces in parameter names always in the same location. 

To use functions that are not declared in your project, you must select the Pick up functions that have no prototype check box on the [General Settings] > Source Parsing > C++ Options page.

Comments

Place comments preceding a symbol or following a symbol. If you place one part of the comment preceding a symbol and one part following a symbol only one part is detected. Tokens have to be the very first characters in a comment line, to be identifiable. 

Doc-O-Matic removes walls in your comments, if they look as follows: the bottom and the top line consist of a continuous line of same characters; the side part consist of one or more continuous lines of same characters. For details, see Comment Finding and Removing Walls.

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