start_time: 2024-03-29 00:15:12 +0800

C/C++工具:Doxygen最简使用说明

96
jdzhangxin
IP属地: 陕西
0.1 2017.09.05 01:00 字数 237
  • 编程技能:编写可读可维护的代码
  • 编程技巧:编写优化高效的代码

简介

开源跨平台的注释文档生成工具。

安装

  1. 下载
  2. 解压tar zxvf doxygen压缩包
  3. 切换到解压后的doxygen主目录cd doxygen解压目录
  4. 创建build目录mkdir build
  5. 切换到build目录cd build
  6. 生成Linux Makefilecmake -G "Unix Makefiles" ../
  7. 编译make
  8. 安装make install

使用

  1. 进入项目目录cd 项目目录
  2. 生成配置文件doxygen –g (默认配置文件名为Doxyfile)
  3. 生成文档文件doxygen

配置文件

# 项目名称,将作为于所生成的程序文档首页标题
PROJECT_NAME        = “Test”
# 文档版本号,可对应于项目版本号,譬如 svn、cvs 所生成的项目版本号
PROJECT_NUMBER      = "1.0.0
# 程序文档输出目录
OUTPUT_DIRECTORY    =  /home/user1/docs
 
# 程序文档输入目录 
INPUT                = /home/user1/project/kernel
 
# 程序文档语言环境
OUTPUT_LANGUAGE      = Chinese
DOXYFILE_ENCODING  = UTF-8
# 只对头文件中的文档化信息生成程序文档 
FILE_PATTERNS        = 
 
# 递归遍历当前目录的子目录,寻找被文档化的程序源文件 
RECURSIVE            = YES 
# 如果是制作 C 程序文档,该选项必须设为 YES,否则默认生成 C++ 文档格式
OPTIMIZE_OUTPUT_FOR_C  = YES
 
#提取信息,包含类的私有数据成员和静态成员
EXTRACT_ALL            = yes
EXTRACT_PRIVATE        = yes
EXTRACT_STATIC        = yes
# 对于使用 typedef 定义的结构体、枚举、联合等数据类型,只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT  = YES
# 在 C++ 程序文档中,该值可以设置为 NO,而在 C 程序文档中,由于 C 语言没有所谓的域/名字空间这样的概念,所以此处设置为 YES
HIDE_SCOPE_NAMES      = YES
# 让 doxygen 静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息
QUIET  = YES
# 递归遍历示例程序目录的子目录,寻找被文档化的程序源文件
EXAMPLE_RECURSIVE      = YES
# 允许程序文档中显示本文档化的函数相互调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文档
GENERATE_LATEX        = NO
# 在程序文档中允许以图例形式显示函数调用关系,前提是你已经安装了 graphviz 软件包
HAVE_DOT              = YES
CALL_GRAPH            = YES
CALLER_GRAPH          = YES
#在最后生成的文档中,把所有的源代码包含在其中
SOURCE BROWSER        = YES
$这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系
GENERATE TREEVIEW      = ALL
No. 文件格式 选项 默认值 作用 相关选项
1 LaTeX GENERATE_LATEX YES/NO YES 产生LaTeX的文件 LATEX_OUTPUT输出目录,默认latex
2 rtf GENERATE_RTF YES/NO YES 产生rtf的文件 RTF_OUTPUT输出目录,默认rtf
3 man GENERATE_MAN YES/NO NO Unix Man Page 格式 MAN_OUTPUT输出目录,默认man
2 rtf GENERATE_XML YES/NO NO 产生xml的文件 XML_OUTPUT输出目录,默认xml

语法简介

  • 简单注释
  • 单行注释:///或者//!
  • 多行注释:/**或者/*!
  • 文件注释
/**
 * @file 文件名
 * @brief 简介
 * @details 细节
 * @mainpage 工程概览
 * @author 作者
 * @version 版本号
 * @date 年-月-日
 */
  • 全局常量/变量/宏定义/结构体定义/类定义的注释
  • 代码前注释
/// 注释
全局常量/变量/宏定义/结构体定义/类定义

例如:

/// 缓存大小
#define BUFSIZ 1024*4
  • 代码后注释
全局常量/变量/宏定义/结构体定义/类定义 ///< 注释

例如:

#define BUFSIZ 1024*4 ///< 缓存大小
  • 函数注释
/**
 * @brief 函数简介
 *
 * @param 形参 参数说明
 * @param 形参 参数说明
 * @return 返回值说明
*/

例如:

/**
 * @brief 主函数
 * @details 程序唯一入口
 *
 * @param argc 命令参数个数
 * @param argv 命令参数指针数组
 * @return @c 0 程序执行成功
 *               @c 1 程序执行失败
*/
int main(int argc, char* argv[]){
}
命令 生成字段名
@param 参数
@return 返回值
@p 参数(后面紧接单词是参数)
@c 代码(后面紧接单词是代码)
  • 其它常用命令
命令 生成字段名 说明
@attention 注意
@bug 缺陷 链接到所有缺陷汇总的缺陷列表
@warning 警告
@see 参考
@code 代码块开始 @endcode成对使用
@endcode 代码块结束 @code成对使用
@todo TODO 链接到所有TODO 汇总的TODO 列表

其他

最后编辑于 :2018-05-16 09:55:32
©著作权归作者所有,转载或内容合作请联系作者
序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
783c64db 45e5 48d7 82e4 95736f50533e 沈念sama 阅读 151511 评论 1 赞 330
序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
783c64db 45e5 48d7 82e4 95736f50533e 沈念sama 阅读 64495 评论 1 赞 273
文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
8 开封第一讲书人 阅读 101595 评论 0 赞 225
文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
8 开封第一讲书人 阅读 42558 评论 0 赞 190
正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
388e473c fe2f 40e0 9301 e357ae8f1b41 茶点故事 阅读 50715 评论 3 赞 270
文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
8 开封第一讲书人 阅读 39672 评论 1 赞 192
那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
783c64db 45e5 48d7 82e4 95736f50533e 沈念sama 阅读 31112 评论 2 赞 291
文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
8 开封第一讲书人 阅读 29837 评论 0 赞 181
序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
783c64db 45e5 48d7 82e4 95736f50533e 沈念sama 阅读 33417 评论 0 赞 228
正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
388e473c fe2f 40e0 9301 e357ae8f1b41 茶点故事 阅读 29928 评论 2 赞 232
正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
388e473c fe2f 40e0 9301 e357ae8f1b41 茶点故事 阅读 31316 评论 1 赞 242
序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
783c64db 45e5 48d7 82e4 95736f50533e 沈念sama 阅读 27773 评论 2 赞 234
正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
388e473c fe2f 40e0 9301 e357ae8f1b41 茶点故事 阅读 32253 评论 3 赞 220
文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
8 开封第一讲书人 阅读 25827 评论 0 赞 8
文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
8 开封第一讲书人 阅读 26440 评论 0 赞 180
我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
783c64db 45e5 48d7 82e4 95736f50533e 沈念sama 阅读 34523 评论 2 赞 249
正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
388e473c fe2f 40e0 9301 e357ae8f1b41 茶点故事 阅读 34583 评论 2 赞 249
end_time: 2024-03-29 00:15:12 +0800 Completed in 157.19055500000002ms