使用doxygen对c++代码进行文档化注释示例

Doxgen的使用包括两个方面：
- 一个是代码的注释规则；
- 一个是利用doxgen生成相应的HTML和chm文件。

注释规则

文件注释

    /*!
    * @file   core.h 
    * @brief  核心类core
    * @author author
    * @date   2016-11-12                                                 
    */
  
  
   
   1
   
   2
   
   3
   
   4
   
   5
   
   6

函数注释

    /*!
     * @param  参数
     * @return 返回值
     * @see    参考对象
     * @note   说明
     */
  
  
   
   1
   
   2
   
   3
   
   4
   
   5
   
   6

类/结构体注释

    /*！@brief 本类的功能：打印错误信息  
     *   
     *   程序的核心类core
     *   程序所有的对象基类
     */ 
  
  
   
   1
   
   2
   
   3
   
   4
   
   5

成员变量注释

    /*！ 成员变量描述 */ 
    int  m_iVar; 
  
  
   
   1
   
   2

或者

    int  m_iVar;     /*!< 成员变量描述 */
  
  
   
   1

文档生成

安装Doxygen

安装 doxygen-1.8.11-setup。
安装 Windows Help Workshop。Doxygen 使用这个工具可以生成 CHM 格式的文档。

Doxygen的配置使用

Wizard=>Project
打开安装后的Doxgen窗口，选择Wizard=>Project，输入一下内容
Wizard=>Output
选择Wizard=>Output,由于我只需要chm，所以只选择了prepare for compressed HTML(.chm)
Expert=>Project
选择Expert=>Project,因为我需要输出中文，所以我选择了gbk和Chinese选项
Expert=>Build
- EXTRACT_ALL 表示：输出所有的函数，但是private和static函数不属于其管制。
- EXTRACT_PRIVATE 表示：输出private函数。
- EXTRACT_STATIC 表示：输出static函数。
- INTERNAL_DOCS 主要指：是否输出注解中的@internal部分。如果没有被启动，那么注解中所有的@internal部分都将在目标帮助中不可见。
- HIDE_SCOPE_NAMES 表示：域隐藏，建议永远不要开启。
- INLINE_INFO ：如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。
- SHOW_FILES ：是否显示文件列表页面，如果开启，那么帮助中会存在一个一个文件列表索引页面。
Expert=>Input
选择Expert=>Input,核对你的input选项，如果有源码之外的文件需要添加，可以在此进行操作，输入编码仍然选择GBK
Expert=>HTML
选择Expert=>HTML，输出chm的文件名称，注意必须输出后缀名称：.chm。HHC的exe路径，在你安装的HTML Help Workshop目录下。编码仍然选择GBK
Run=>Run doxgen
选择Run=>Run doxgen，看见finished就表示大功告成了！
完成