Doxygen的注释风格（国外英文资料）.doc

Doxygen的注释风格（国外英文资料） 5 Doxygen annotation style 5.1 review There are two types of descriptions that can be described in each code term, which will be formatted in the document: one is brief description and the other is detailed. Both are optional, but not at the same time. As the name implies, a brief description is described in a single line. Detailed description provides longer, more detailed documentation. Doxygen supports c-style comments, c + + style comments, and javaDoc style comments, which are described below. If you need to generate a beautiful document through Doxygen, there are several ways to annotate the style supported by Doxygen: 1) header (including.h and.cpp) It is mainly used to declare copyright, to describe the function of this document, and to document version information 2) the definition of a class It is used to describe the functionality of the class, and it can also contain a brief description of the usage method or note The member variable definition of a class The member variable is briefly described above the member variables of the class The member function definition of a class A brief description of the function of the member is described above the member function of the class definition 5) function in the function of the implementation of the code, the function of the detailed function, parameter definition, the meaning of the return value, use this function need to be aware of problems, the function USES the other class or function description, etc The instructions supported by Doxygen Overview of 5.2.1 Can add some Doxygen support of instructions in the comments, the main function is to control the output document typesetting format, use these instructions when needed at the front and "\" or "@" symbol (JavaDoc style), told Doxygen these are some of the special instructions, by joining these instructions and equipped with corresponding text, you can generate more extensive documentation, the following instructions which are frequen