DOXYgen's common annotation tags, through these tags, can generate standardized code documents; you can also help us manage code.
These tags are written in the comment block, see example with the email (_COMMON / OBJ.H).
Description Type: Divided into a summary description and detailed instructions / Brief, follow the summary, you can also use "//!" To start comments. Detailed description: After the abstract statement, the interval is written, see example. The basic structure of the instructions: / file [file name] written by writing files, followed by the file name of this file; written in one line, write this file. / Class [class name] written by writing classes, followed by the class name; one line of writing classes. Description tags for functions: These tags will use different fonts and formats in the detailed description of the function, highlight it. / Param [param name] Description of write function parameters, followed by parameter name; keep up with parameters. / RETURN write function returns to be explained, and then the returns are worth mentioning. / WARNING warning, follow the warning content. / Remarks comments, follow the contents of the comments. Description of the subject can be generated: / TODO The code described by this tag will appear in the TODO list. / Bugs appears in the BUG list in this tag. / TEST will appear in the Test list in this tag. / DepRecated is appeared in the DepRecated list. / defgroup [group name] [brief] Defines a code block to note the code block; Note that Group Name must be unique; another line of writing detailed description / {code block start /} code block technology formatted Description Tag: - Theme - # 子 标 1 1 / N Description - # Sub Title 2 / N Description Generation Document You can display a list of numbers Note: In the comment, the HTML formatted tag can be fully used. The above is a brief description of the commonly used tags; it is recommended to see Doxygen's documentation to be familiar.
