doxygen 注释规范_Doxygen 注释语法规范

背景

这一块的内容更多的是作为了解，但是可以以这样的规范作为自己的编程注释习惯，提高自己的软实力。

Doxygen注释语法

注释格式

块注释建议统一使用

/**

……

***/

行注释建议统一使用

///< …

/** …… */

Doxygen常用注释命令

@exception {exception description} 对一个异常对象进行注释。

@warning {warning message } 一些需要注意的事情

@todo { things to be done } 对将要做的事情进行注释，链接到所有TODO 汇总的TODO 列表

@bug 缺陷，链接到所有缺陷汇总的缺陷列表

@see {comment with reference to other items } 一段包含其他部分引用的注释，中间包含对其他代码项的名称，自动产生对其的引用链接。

@relates 通常用做把非成员函数的注释文档包含在类的说明文档中。

@since {text} 通常用来说明从什么版本、时间写此部分代码。

@deprecated

@pre { description of the precondition } 用来说明代码项的前提条件。

@post { description of the postcondition } 用来说明代码项之后的使用条件。

@code 在注释中开始说明一段代码，直到@endcode命令。

@endcode 注释中代码段的结束。

@co