C++代码注释详解

常用注释语法

• 注释写在对应的函数或变量前面。JavaDoc类型的多行注释风格如下：

/**
* 这里为注释.
*/

• 一般注释中有简要注释和详细注释，简要注释有多种标识方式，这里推荐使用@brief命令强制说明，例如：
  

/**
* @brief 这里为简要注释.
*
* 这里为详细注释.
*/

• @brief之后为简要注释，简要注释结束的标志是一个点号，或一个空行。简要注释之后的注释为详细注释，因此也可以写成：其中\n为换行符。

/**
* @brief 简要注释. 详细注释. \n
* 这里仍然为详细注释.
*/

• 下面对几种注释类型进行描述。

文件头注释

• 一般@file后为空，Doxygen会默认为是@file所在文件的文件名。[]表示可选，{}表示重复0到N次，<>表示必须参数，@author表示作者，@data表示日期，@version表示版本号。

/** 
* @file [file-name]
* @brief brief description for the file.
* @author <list of authors>
* {@author <list of authors>}
* [@author <authors description>]
* @date <date>
* @version <version number>
*
* d