doxygen入门

doxygen入门

• 1. 认识
  • 1.1. 前言
• 2. Doxygen软件使用
• 3. 代码规范
  • 3.1. C规范
    • 3.1.1. 多行注释
    • 3.1.2. 单行注释
    • 3.1.3. 记录文件、结构、联合、类或枚举的成员
    • 3.1.4. 注释明显
  • 3.2. 指令
• 4. 链接

1. 认识

• Doxygen

  • 通过代码中特定的批注生成说明文件。
  • 通过提取代码中结构自动生成

• Graphviz

  • 用于绘制DOT语言脚本描绘的图形。（要使用Doxygen生成依赖图、继承图以及协作图，必须先安装graphviz软件。）

• HTML Help WorkShop

  • 能将HTML文件编译成CHM文档。（Doxygen软件默认生成HTML文件或Latex文件，我们要通过HTML生成CHM文档，需要先安装HTML Help WorkShop软件，并在Doxygen中进行关联。）

1.1. 前言

doxygen通过特定的注释实现识别，有：

• 注释样式
• 命令
  学习根据官方的文档即可

2. Doxygen软件使用

3. 代码规范

3.1. C规范

• 多行注释
• 单行注释
• 记录文件、结构、联合、类或枚举的成员
• 注释明显

3.1.1. 多行注释

• 样式1

/**
 * ... text ...
 */

• 样式2

/*!
 * ... text ...
 */

• 样式3

/*!
 ... text ...
*/

3.1.2. 单行注释

• 样式1

///
/// ... text ...
///

• 样式2

//!
//!... text ...
//!

3.1.3. 记录文件、结构、联合、类或枚举的成员

重点符号：<

• 样式1

内部变量; /*!<成员后详细说明*/

• 样式2

内部变量; /**<会员后详细说明*/

• 样式3

内部变量;//!< 成员后详细说明
         //!<

• 样式4

内部变量；///< 成员后详细说明
         ///<

3.1.4. 注释明显

3.2. 指令

有很多，具体查看官方文档。这里说明简单的用法和常用的一些命令。
命令触发符号：\ 或是 @

\file 记录文件
\date：日期
\version：版本
\author：作者
\todo：代办

\brief：简要说明
\param：函数元素
\return：返回数值

\struct 记录 C 结构。
\union 记录工会。
\enum 记录枚举类型。
\fn 记录一个函数。
\var 记录变量或 typedef 或枚举值。
\def 记录#define。
\typedef 记录类型定义。

4. 链接

• Doxygen official web
• Doxygne manual
• Doxygen manual - Documenting the code
• Doxygen快速入门(含：软件的使用说明，代码规范)- zhihu