doxygen常用注释语法

《doxygen常用注释语法》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、2.常用注释语法 注释写在对应的函数或变量前面。  简要注释和详细注释： /** * @brief Brief Description.  *  * Detailed Description  */ 简要注释遇到一个空行或新的命令会结束，后面的就表示是详细注释。  JavaDoc风格下，自动会把第一个句号前的文本作为简要注释，后面的为详细注释。你也可以用空行把简要注释和详细注释分开。注意要设置JAVADOC_AUTOBRIEF设为YES。  为了注释一个类中的member，首先要对该类作注释。同样的问题上升到namespace

2、。要注释一个全局的function，typedef，enum或preprocessor定义，你需要首先定义（只能用@file，因为文件不再任何东西里面，就只能用特殊命令实现了，而不像类、函数等，既可以在上方放注释，也可以用@class、@fn进行注释）包含它的文件。  （1）文件头注释 /** @file [file‐name]  *@brief brief description * @author   * [@author ]  * @date <

3、date>  * @version   * @note  * detailed description */  一般@file后我们空着，Doxygen会默认为是@file所在文件的文件名。  []表示可选，{}表示重复0到N次，<>表示必须参数。@author 表示作者，@data表示日期，@version表示版本号。 （2）类注释 /**  * @class  [header‐file] [header‐name]  * @brief brief descriptio

4、n * @author   * @note  * detailed description */ header‐file是类声明所在的头文件名字，header‐name是要显示的链接文字，一般为头文件的真实路径。 （3）函数注释 /**  * @brief brief description * @author   * {@param[in

5、out]  }  * @exception

6、    * {@exception  }  * @return   * {@return }  * @note  * detailed description * @remarks   * {@remarks 

7、}  * [@deprecated ]  * [@since when(time or version)]  * [@see references{,references}]  */ @可用代替，但我倾向于用@。 @param[in

8、out]  参数名及其解释 @exception 用来说明异常类及抛出条件 @return  对函数返回值做解释 @note  表示注解，暴露给源码阅读者的文档 @remark  表示评论，暴露给客户程序员的文档 @since  表示从那个版本

9、起开始有了这个函数 @deprecated 引起不推荐使用的警告 @see  表示交叉参考 函数的详细注释用@note代替详细注释，因为详细注释要空行隔开，容易忘记。（4）成员注释 /**< 或//<用来注释成员，放在成员后面，格式如下： int var; /**< Detailed description after the member */ int var; ///< Brief description after the member 此语法对函数成员也适用。  （5）枚举类型注释       /** @brief A

10、nother enum, with inline docs */enum AnotherEnum       {         V1, /**< value 1 */         V2  /**< value 2 */       };  一般约定：  （1）每个.h和