doxygen注释语法3

1、文件注释
每个.h和.cpp文件的头部，必须要有简要注释和详细注释，习惯用法如下：[cpp] view plaincopy
1./** @file
2.* @brief brief description
3.* @author <list of authors>
4.* @date <date>
5.* @version <version number>
6.* @note
7.* detailed description
8.*/
2、类注释
每个类的声明上方，必须要有简要注释和详细注释，习惯用法如下：[cpp] view plaincopy
1./**
2.* @class
3.* @brief brief description
4.* @author <list of authors>
5.* @note
6.* detailed description
7.*/
3、全局变量和全局宏
全局变量和全局宏必须要有注释。

如果注释较短，则可以在
上方用/** @brief some brief description */
或右方用///< some brief description。

进行简要注释。

4、函数注释
任何函数都必须要有简要注释和详细注释，习惯用法如下：
[cpp] view plaincopy
1./**
2.* @brief brief description
3.* @author <list of authors>
4.* @param[in|out] <parameter‐name><parameter description>
5.* @exception <exception‐object><exception description>
6.* @return <description of the return value>
7.* @note
8.* detailed description
9.* @remarks <remark text>
10.*/
4.1类的函数成员
在头文件的定义处进行简要注释，放在上方：
[cpp] view plaincopy
1.class Test
2.{
3.public:
4./** @brief brief description */
5.int m_test(int a);
6.}
而在实现处给出详细注释：
[cpp] view plaincopy
1./**
2.* @author <list of authors>
3.* @param [in|out] <parameter‐name><parameter descriptio
n>
4.* @exception <exception‐object><exception description>
5.* @return <description of the return value>
6.* @note
7.* detailed description
8.* @remarks <remark text>
9.*/
10.int Test::m_test(int a)
11.{
12.return 0;
13.}
4.2纯虚函数
由于没有实现，则简要注释和详细注释不需分开。

4.3类的数据成员
只在头文件的定义处进行简要注释，不要详细注释。

可以在上方用/** @brief some brief description */
或右方用///< some brief description
5、枚举定义
每个枚举定义必须添加注释,格式如下:
[html] view plaincopy
1./** Another enum, with inline docs */
2.enum AnotherEnum
3.{
4.V1, ///< value 1
5.V2 ///< value 2
6.};
6、示例
下面是一个简单的例子，完全符合约定：
6.1首先是文件定义
/** @file
* @brief a brief description for the file.
* @author soulmachine
* @date 2008/07/02
* @version 0.1
*
* detailed description for test.cpp
*/
6.2全局函数定义
/** @brief global function, no details
* @note some details about global function*/
[cpp] view plaincopy
1.void global_test();
6.3类定义
/** @class Test test.h "inc/test.h"
* @brief A test class.
*
* A more elaborate class description.
*/
[cpp] view plaincopy
1.class Test
2.{
3.public:
4./** @brief A enum, with inline docs */
5.enum TEnum
6.{
al1, /**< enum value TVal1. */
al2, /**< enum value TVal2. */
al3 /**< enum value TVal3. */
10.}
11.//这里Doxygen对enumPtr的处理有点问题
12.*enumPtr, ///< enum pointer.
13.enumVar; ///< enum variable.
14./** @brief A constructor. */
15.Test(); /** @brief A destructor. */
16.~Test(); /** @brief a normal member taking two
arguments and returning an integer value. */
17.int testMe(int a,const char *s);
18.
19.
20./** @brief A pure virtual member.
21.* @param[in] c1 the first argument.
22.* @param[in] c2 the second argument.
23.* @see testMe()
24.*/
25.virtual void testMeToo(char c1,char c2) = 0;
26.int publicVar;//< a public variable.
27./** @brief a function variable, note Details.
*/
28.int (*handler)(int a,int b);
29./** @brief brief before delaration */
30.int m_func(int a);
31.};
/** A more elaborate description of the constructor. */
[cpp] view plaincopy
1.Test::Test()
2.
3.{
4.
5.}
/** A more elaborate description of the destructor. */
[cpp] view plaincopy
1.Test::~Test()
2.
3.{
4.
5.}
/**
* @param[in] a an integer argument.
* @param[in] s a constant character pointer.
* @return The test results
* @note Details.
* @par* Another detail.
* @see Test()
* @see ~Test()
* @see testMeToo()
* @see publicVar()
*/
[cpp] view plaincopy
1.int Test::testMe(int a,const char *s)
2.{
3.return 0;
4.}
/**
* @param[in] a a interger
* @return 0
* @note detailed description
* @remarks remarks,important
* @since 1.0
* @see testMeToo
*/
[cpp] view plaincopy
1.int Test::m_func(int a)
2.{
3.return 0;
4.}。