Doxygen的注释风格（Comment style of Doxygen）.docVIP

Doxygen的注释风格（Comment style of Doxygen） 5 Doxygen annotation style 5.1 summary In each code entry there are two types of descriptions. These two types of descriptions are formatted together in the document: one is the brief description, and the other is detailed. The two are optional, but not at the same time. As the name suggests, brief is a brief description within a line. The detailed description (detailed description) provides longer, more detailed documentation. Doxygen supports c style annotations, c++ style annotations, and javaDoc style annotations, which are described below. If you need to generate beautiful documents through Doxygen, there are several areas that need to be annotated using the Doxygen supported style: 1) file headers (including.H and.Cpp) Mainly used to declare copyright, describes the implementation of this document functions, as well as file version information 2) class definition Primarily used to describe the functionality of that class, as well as a brief description of how to use the methods or considerations 3) the member variable definition of a class At the top of the class member variable, a brief description of the member variable is given 4) the member function definition of a class At the top of the member function of the class definition, a brief description of the function of the member function is given 5) to achieve the function in the code function, function parameters, detailed description of the meaning, the function returns the value of the meaning and use of this function need to pay attention to the problem, the use of other functions of the class or function. 5.2 Doxygen support instruction 5.2.1 overview You can add some Doxygen instructions in the notes, the main role is to control the output document format, use these instructions to add in front of \ or @ (JavaDoc style) symbol, tells Doxygen these are some special instructions, by adding these instructions and equipped with the corresponding text, can to generate