Doxygen使用指南，Doxygen介绍一

Doxygen使用指南

一、Doxygen的介绍

Doxygen能够很好的解决代码和文档同步问题，在代码中加入有@标识符的注释，修改代码时实时修改注释，然后通过Doxygen可以生成更新后的文档。 Doxygen是基于GPL的开源项目，是一个非常优秀的文档系统，当前支持在大多数unix（包括linux），windows家族，Mac系统上运行，完全支持C++, C, Java, IDL（Corba和Microsoft 家族）语言，部分支持PHP和C#语言，输出格式包括HTML、latex、RTF、ps、PDF、压缩的HTML和unix manpage。

同时，通过对注释文件的处理，现在支持中文注释的书写。

二、Doxygen的安装

请读压缩包中readme.txt安装。

三、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] param2 参数2说明

 *  @return 返回值说明

 */

int func(int param1, int param2);

 

/*

 * 打开文件 /n

 *  文件打开成功后，必须使用 ::CloseFile 函数关闭。

 *  @param[in] file_name 文件名字符串

 *  @param[in] file_mode 文件打开模式字符串，可以由以下几个模块组合而成：

 *  - r 读取

 *  - w 可写

 *  - a 添加

 *  - t 文本模式(不能与 b 联用)

 *  - b 二进制模式(不能与 t 联用)

 *  @return 返回文件编号

 *  - -1 表示打开文件失败

 

 *  @note 文件打开成功后，必须使用 ::CloseFile 函数关闭

 *  @par 示例:

 *  @code

    // 用文本只读方式打开文件

    int f = OpenFile("d://test.txt", "rt");

 *  @endcode

 

 *  @see ::ReadFile ::WriteFile ::CloseFile

 *  @deprecated 由于特殊的原因，这个函数可能会在将来的版本中取消。

 */

int OpenFile(const char* file_name, const char* file_mode);

 

5. 枚举类型定义

/** 枚举常量 */

typedef enum TDayOfWeek

{

SUN = 0, /**<  星期天（注意，要以 “<” 小于号开头） */

MON = 1, /**<  星期一 */

TUE = 2, /**<  星期二 */

WED = 3, /**<  星期三 */

THU = 4, /**<  星期四 */

FRI = 5, /**<  星期五 */

SAT = 6  /**<  星期六 */

}

/** 定义类型 TEnumDayOfWeek */

TEnumDayOfWeek;  

　　

6. 项目符号标记

  /* 

   *  A list of events:

   *    - mouse events

   *         -# mouse move event

   *         -# mouse click event/n

   *            More info about the click event.

   *         -# mouse double click event

   *    - keyboard events

   *         -# key down event

   *         -# key up event

   *

   *  More text here.

   */

 

结果为：

A list of events:

• mouse events
  1. mouse move event
  2. mouse click event
  3. More info about the click event.
  4. mouse double click event
• keyboard events
  1. key down event
  2. key up event

More text here.

三、Doxygen实际效果参考

在范例.rar文件中，源码文件夹里面为注释后的源码，文档文件夹为产生的文档。

大家可以参考。

 

注：装载自网络