doxygen标准VC注释_完整的配置步骤.docVIP

C++ 程序文档生成器介绍(doxygen) ? 程序文档，曾经是程序员的一个头痛问题。写一个程序文档，比较花时间，但不是很难；麻烦的是当程序修改后，程序文档也要跟着同步更新，否则文档和程序就要脱节，文档也就变成没用的东西了。好在有许多好用的文档生成器来解决这个问题。目前比较流行的C++文档生成器是doxygen。本文就简单的介绍一下doxygen的文档注释方法，以供初学者参考： 1.?模块定义（单独显示一页） /*?*?@defgroup?模块名?模块的说明文字 ?*?@{ ?*/ ? ?... 定义的内容 ... ? /**?@}?*/ // 模块结尾 ? 2.?分组定义（在一页内分组显示） /*?*?@name?分组说明文字 ?*?@{ ?*/ ? ?... 定义的内容 ... ? /**?@}?*/ ? 3.?变量、宏定义、类型定义简要说明 /**?简要说明文字?*/ #define FLOAT float ? /**?@brief 简要说明文字（在前面加 @brief 是标准格式）?*/ #define MIN_UINT 0 ? /*?*?分行的简要说明?\n ?*??这是第二行的简要说明 ?*/ int?b; ? 4.?函数说明 /*?*?简要的函数说明文字? ?*??@param?[in]?param1?参数1说明 ?*??@param?[out]