源代码文档生成 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软件可以从这里下载，软件本身用法非常简单。

二、Doxygen安装

1、在Windows里面安装和使用

Windows下安装包可以在https://olex.openlogic.com/packages/doxygen#1894下载安装，最新版本为1.5.6。

第一步，配置Doxygen，选择Wizard，填写源代码目录，生成目标文件目录

选择All entities，c++ output

选择prpare for compressed HTML

第二步，保存配置文件

第三步，选择目录

第四步，点击Start，开始生成文件。

在完成后，可以在目标目录下可以看到目录html，在该目录下点击index.html，就可以浏览生成后的文档，如果想要生成单一的chm文件，下载chm制作精灵来制作。

2、在Carbide c++中安装

Carbide c++ 中使用doxygen：打开Help -> Software Updates -> Find and Install... -> Search for new features to install -> Next -> New Remote Site...，

url输入http://download.gna.org/eclox/update，如下图1所示，然后选择Finish，等下载完成后，选择安装，安装完后重启carbide c++，这样可以在carbide c++工具栏中找到@图形。

配置Doxygen更新

三、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
mouse move event
mouse click event
More info about the click event.
mouse double click event
keyboard events
key down event
key up event

More text here.
代码示范：
/*
* @defgroup EXAMPLES 自动注释文档范例
* @author 沐枫
* @version 1.0
* @date 2004-2005
* @{
*/

/*
* @name 文件名常量
* @{
*/

/** 日志文件名 */
#define LOG_FILENAME "d://log//debug.log"
/** 数据文件名 */
#define DATA_FILENAME "d://data//detail.dat"
/** 存档文件名 */
#define BAK_FILENAME "d://data//backup.dat"

/** @}*/ // 文件名常量

/*
* @name 系统状态常量
* @{
*/

/** 正常状态 */
#define SYS_NORMAL 0
/** 故障状态 */
#define SYS_FAULT 1
/** 警告状态 */
#define SYS_WARNNING 2

/** @}*/ // 系统状态常量

/** 枚举常量 */
typedef enum TDayOfWeek
{
        SUN = 0, /**< 星期天 */
        MON = 1, /**< 星期一 */
        TUE = 2, /**< 星期二 */
        WED = 3, /**< 星期三 */
        THU = 4, /**< 星期四 */
        FRI = 5, /**< 星期五 */
        SAT = 6 /**< 星期六 */
}
/** 定义类型 TEnumDayOfWeek */
TEnumDayOfWeek;
/** 定义类型 PEnumDayOfWeek */
typedef TEnumDayOfWeek* PEnumDayOfWeek;

/** 定义枚举变量 enum1 */
TEnumDayOfWeek enum1;
/** 定义枚举指针变量 enum2 */
PEnumDayOfWeek p_enum2;

/*
* @defgroup FileUtils 文件操作函数
* @{
*/

/*
* 打开文件 /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);

/*
* 读取文件
* @param[in] file 文件编号，参见：::OpenFile
* @param[out] buffer 用于存放读取的文件内容
* @param[in] len 需要读取的文件长度
* @return 返回读取文件的长度
* - -1 表示读取文件失败

* @pre /e file 变量必须使用 ::OpenFile 返回值
* @pre /e buffer 不能为 NULL
* @see ::OpenFile ::WriteFile ::CloseFile
*/
int ReadFile(int file, char* buffer, int len);

/*
* 写入文件
* @param[in] file 文件编号，参见：::OpenFile
* @param[in] buffer 用于存放将要写入的文件内容
* @param[in] len 需要写入的文件长度
* @return 返回写入的长度
* - -1 表示写入文件失败

* @pre /e file 变量必须使用 ::OpenFile 返回值
* @see ::OpenFile ::ReadFile ::CloseFile
*/
int WriteFile(int file, const char* buffer, int len);

/*
* 关闭文件
* @param file 文件编号，参见：::OpenFile
* @retval 0 为成功
* @retval -1 表示失败

* @see ::OpenFile ::WriteFile ::ReadFile
* @deprecated 由于特殊的原因，这个函数可能会在将来的版本中取消。
*/
int CloseFile(int file);

/** @}*/ // 文件操作函数

/** @}*/ // 自动注释文档范例

生成的chm文档截图：

发表于 @ 2009年05月15日　13:45:00 | 评论( 0 ) | 举报| 收藏

原文:http://blog.csdn.net/kim_fu/archive/2009/05/15/4188627.aspx

源代码文档生成 Doxygen介绍(转载)相关推荐

软著申请60页的源代码文档生成工具
工具名称:源代码文档生成工具使用范围:计算机软著申请时制作代码文档使用,满足现今的代码文档要求. 下载地址:https://download.csdn.net/download/hj960511/8 ...
java类可视化doxygen_安装doxygen（一个自动文档生成工具）+Graphviz图形可视化软件...
参考文章: 1 Doxygen简介 1.1 What to do? 使用Doxygen生成文档,主要是两件事: 写一个配置文件(Doxyfile),一般用Doxywizard生成后,再手工修改[不建议 ...
文档生成工具-Doxygen使用方法以及注释规则
最近接触了一款程序文档生成工具-Doxygen.在网上一搜索原来这么多人知道,打算把它的使用做一个总结,以及其注释的规则. 概述: Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文 ...
Doxygen自动文档生成工具在Eclipse中的集成及使用举例
你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的 ...
python doc_Python文档生成工具pydoc使用介绍
在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc.doxygen.sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介 ...
Word文档生成神器：开源项目poi.tl使用介绍
导航: Word文档生成神器:开源项目poi-tl使用介绍一. 概述 1.1 适合的场景 1.2 poi-tl的优势二. poi-tl实例演示: 2.1 使用poi-tl生成word文档三. 更 ...
一款常用文档生成工具：Doxygen
关注+星标公众号,不错过精彩内容来源 | 简书编排 | strongerHuang 程序员的很多文档,特别是有代码的文档,绝大部分都是由一款文档生成工具[Doxygen]生成. 什么是Doxyge ...
.NET平台开源项目速览(4).NET文档生成工具ADB及使用
.NET平台开源项目速览(4).NET文档生成工具ADB及使用原文:.NET平台开源项目速览(4).NET文档生成工具ADB及使用很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习 ...
GDAL源码剖析（三）之Swig编译和帮助文档生成
一.Swig编译 1.Swig介绍 SWIG全称是Simplified Wrapper and Interface Generator,官方网站:http://www.swig.org/.SWIG是个 ...

源代码文档生成 Doxygen介绍(转载)

源代码文档生成 Doxygen介绍(转载)相关推荐

最新文章

热门文章