Doxygen极简使用说明

<?xml version="1.0" encoding="utf-8"?>

Doxygen

Table of Contents

• 1. Introduction
• 2. Syntax
  • 2.1. 简要描述
  • 2.2. 函数描述
  • 2.3. 行尾注释
  • 2.4. 对于生成格式的说明
• 3. Application

1 Introduction

Doxygen是一种开源的，跨平台的，以类似Javadoc风格描述的文档系统。简单的说就是，按照一定的格式写注释，doxygen根据注释生成文档，解放程序员的工作。另外，doxygen也可以提取代码结构，借助自动生成的包含依赖图，继承图以及协作图来可视化文档之间的关系。

2 Syntax

2.1 简要描述

Doxygen将下列注释解析成简要描述，可以用于描述宏、变量、类型等等

/**
 * @brief 简要描述
 * 简要描述
 * ……
 */

2.2 函数描述

/**
 * @brief 函数描述
 * @param [in/out] param1 参数描述
 * @note 说明
 * @return 返回值描述
 */

还可以通过":: 名字"生成指向名字的超链接，链接到函数、结构等

2.3 行尾注释

对枚举、结构等的成员进行注释，可以使用行尾注释，使注释更加紧凑

/**< 说明内容 */

2.4 对于生成格式的说明

doxygen还有对于格式的控制说明，如生成的说明是否单独成页，那几个说明在一起显示等，如果对生成的文档有更严格的要求，可以自行学习这方面内容。

3 Application

1. doxygen -g Doxyfile :: 生成一个通用的配置文件
2. 编辑生成的配置文件，其中有几个选项是必填的

   <OUTPUT_DIRECTORY>

   生成文档的目录

   <INPUT>

   源代码目录

   <RECURSIVE>

   是否需要递归解析源代码目录，一般配置成Yes

   <EXTRACT_ALL>              是否提取没有注释的函数信息 <EXTRACT_PRIVATE>              是否提取私有数据成员，一般配置成Yes <EXTRACT_STATIC>              是否提取静态成员

   还有几个跟生成格式相关的选项，包括html，chm，rtf等，一般都是选上的，不用管。

3. doxygen Doxyfile :: 根据配置文件生成文档

Author: zhangkai

Created: 2017-07-06 四 12:07

Emacs 24.5.1 (Org mode 8.2.10)