代码说明生成工具doxygen的使用

功能:产生代码说明文档


代码说明文档内容:

        显示源代码的文件列表

        显示源代码的宏定义、类、函数等列表

        显示函数、类的注释

        高级功能:

              显示函数调用关系图(个人觉得这个功能用sourceinsight即可)


对开发的帮助:

        强制规范注释,帮助二次开发人员从整体上了解源码的结构。


推荐版本:Doxygen 1.7.4(Windows)


代码说明文档生成步骤:

一是在程序代码中加上符合Doxygen所定义批注格式

        二是使用Doxywizard进行配置

        三是使用Doxygen来产生批注文档


Doxygen所定义批注格式:

     /**
     * @brief ExFunc2的简易说明
     *
     * ExFunc3()传回两个参数相加的值。
     *
     * @param a 用来相加的参数。
     * @param b 用来相加的参数。
     * @return 传回两个参数相加的结果。
     */


Doxywizard配置: 用户界面,大部分保持默认配置即可,一般看界面提示即可知道怎么配置

常规手动配置内容:

       代码项目名称、版本、源码路径、代码说明文档路径

        代码说明文档格式(HTML、CHM(需安装Windows Help Workshop)、PDF)

        代码说明文档语言(中文可选)

        输入文件格式(若想不输入中文乱码,必须将INPUT_ENCODING设置成GB2312)

 

Doxygen来产生批注文档:

      点击按钮RUN

    

;