Linux下使用doxygen自动生成注释和文档

——chin

——2012/11/15

一、    安装工具

1.   获取DoxygenToolkit.vim插件

下载地址:http://www.vim.org/scripts/script.php?script_id=987

将其拷贝到如下目录:

/usr/share/vim/vim72/plugin/

2.   获取doxygen-1.8.2.src.tar.gz源码包

该工具用于生成文档和注释,可以从其官网上获取:

http://www.doxygen.org

安装:

1)tar xvfz doxygen-1.8.2.src.tar.gz

2)cd doxygen-1.8.2

3)./configure

4)make

5)make install

安装完成后可执行文件存放路径如下:/usr/bin/doxygen

3.   安装graphviz软件

这个软件是用图形化的方式显示函数间的调用关系。

使用yum安装:yum –y install graphviz

二、         配置Doxygen

步骤:

1、进入项目目录(test为例说明)cd test/

2、生成配置文件Doxygen g

默认生成的配置文件名为 "Doxyfile",也可以采用 "doxygen -g your-cfg-filename" 命令格式指定所生成的配置文件名。如无特殊需要,采用默认的配置文件名即可。

Doxyfile 文件内容非常多,大概 1000 多行,不过其中约 4/5 都是注释,每个配置选项都有一段详细的注释。日后,如果对 Doxygen 各配置选项的意义有一定了解,可以在生成配置文件的命令中添加 "-s" 选项,生成不含注释的配置文件,操作如下:$ doxygen    -s    -g

3、配置文件的相应设置,这里已经有个模板Doxyfile(test文件夹下),可以根据需要更改相应设置

项目名称,将作为于所生成的程序文档首页标题

PROJECT_NAME           = Test

文档版本号,可对应于项目版本号,譬如 svncvs 所生成的项目版本号

PROJECT_NUMBER       = "1.0.0

程序文档输出目录

OUTPUT_DIRECTORY    =  doc/

程序文档语言环境

OUTPUT_LANGUAGE    = Chinese

如果是制作 C 程序文档,该选项必须设为 YES,否则默认生成 C++ 文档格式

OPTIMIZE_OUTPUT_FOR_C  = YES

对于使用 typedef 定义的结构体、枚举、联合等数据类型,只按照 typedef 定义的类型名进行文档化

TYPEDEF_HIDES_STRUCT   = YES

 C++ 程序文档中,该值可以设置为 NO,而在 C 程序文档中,由于 C 语言没有所谓的域/名字空间这样的概念,所以此处设置为 YES

HIDE_SCOPE_NAMES        = YES

 doxygen 静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息

QUIET   = YES

只对头文件中的文档化信息生成程序文档

FILE_PATTERNS          = *.h

递归遍历当前目录的子目录,寻找被文档化的程序源文件

RECURSIVE              = YES

示例程序目录

EXAMPLE_PATH           = example/

示例程序的头文档 (.h 文件与实现文档 (.c 文件都作为程序文档化对象

EXAMPLE_PATTERNS       = *.c / *.h

递归遍历示例程序目录的子目录,寻找被文档化的程序源文件

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

#doxygen从配置文件所在的文件夹开始,递归地搜索所有的子目录及源文件

RECURSIVE = YES

#在最后生成的文档中,把所有的源代码包含在其中

SOURCE BROWSER = YES

$这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系

GENERATE TREEVIEW  ALL

 

4、此外还可以根据自己的需要配置如下选项:

TAB_SIZE 主要是帮助文件中代码的缩进尺寸,譬如@code@endcode段中代码的排版,建议符合习惯,设置成4
    OPTIMIZE_OUTPUT_FOR_C 
这个选项选择后,生成文档的一些描述性名称会发生变化,主要是符合C习惯。如果是纯C代码,建议选择。
    SUBGROUPING
这个选项选择后,输出将会按类型分组。这个页面是生成帮助信息中比较关键的配置页面
    EXTRACT_ALL 
表示输出所有的函数,但是privatestatic函数不属于其管制。
    EXTRACT_PRIVATE 
表示输出private函数。
    EXTRACT_STATIC 
表示输出static函数。同时还有几个EXTRACT,相应查看文档即可。
    HIDE_UNDOC_MEMBERS 
表示那些没有使用doxygen格式描述的文档(函数或类等)就不显示了。当然,如果EXTRACT_ALL被启用,那么这个标志其实是被忽略的。
    INTERNAL_DOCS 
主要指是否输出注解中的@internal部分。如果没有被启动,那么注解中所有的@internal部分都将在目标帮助中不可见。
    CASE_SENSE_NAMES 
是否关注大小写名称,注意,如果开启了,那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说,建议永远不要开启。
    HIDE_SCOPE_NAMES 
域隐藏,建议永远不要开启。
    SHOW_INCLUDE_FILES 
是否显示包含文件,如果开启,帮助中会专门生成一个页面,里面包含所有包含文件的列表。
    INLINE_INFO 
如果开启,那么在帮助文档中,inline函数前面会有一个inline修饰词来标明。
    SORT_MEMBER_DOCS 
如果开启,那么在帮助文档列表显示的时候,函数名称会排序,否则按照解释的顺序显示。
    GENERATE_TODOLIST 
是否生成TODOLIST页面,如果开启,那么包含在@todo注解中的内容将会单独生成并显示在一个页面中,其他的GENERATE选项同。
    SHOW_USED_FILES 
是否在函数或类等的帮助中,最下面显示函数或类的来源文件。
    SHOW_FILES 
是否显示文件列表页面,如果开启,那么帮助中会存在一个一个文件列表索引页面。

主要用来设置编译时的输出信息选项。编译时的输出信息,主要可以用来提醒一些输入的错误语法。
    QUIET 
如果开启,那么表示关闭编译时的输出信息。
    WARN_FORMAT 
表示日志输出的格式,没必要修改。
    WARN_LOGFILE 
表示信息是否输出到LOG文件,因为有DoxyWizard的存在,所以这个选项没有必要使用。


    CHM_FILE 
表示输出的chm文件路径
    GENERATE_CHI 
表示索引文件是否单独输出,建议关闭。否则每次生成两个文件,比较麻烦。             
    TOC_EXPAND 
表示是否在索引中列举成员名称以及分组(譬如函数,枚举)名称。

三、         生成源程序文档

准备好 Doxygen 的工作环境后,就需要根据 Doxygen 所定义的注释规则,对程序源码进行文档化。换句话说,就是在对程序源码添加注释时,要按照 Doxygen 的游戏规则来搞。

Doxygen 的注释类型可分为:

l、行间注释:注释语句不与程序源码出现在同一行,主要用于注释头文件中出现的结构体 (struct)、枚举 (enum)、联合 (uion) 等数据类型,以及程序接口的功能与使用约定;

2、行内注释:注释语句与程序源码出现在同一行内,主要用于代码的局部注释。

注释的种类有很多,下面是其中的一种:

Doxygen 认可的行间注释标记见下例:

/**

 * 这是行间注释标记示例
    */

Doxygen 认可的行内注释标记见下例:

typedef struct {
        double coord[3];     ///
这是行内注释示例

}M2_3D_Point;

3、程序文档生成

现在开始生成程序文档,将终端的工作目录定位在test 目录,然后键入:

$ doxygen    your-cfg-filename

your-cfg-filename Doxygen 配置文件名,如果是使用 "doxygen -g" 生成的配置文件——Doxyfile,那么可以在终端里仅键入 "doxygen" 命令即可生成程序文档。

生成的文档位于test/doc/html 目录中,使用浏览器打开该目录中的 index.html 文件,即可看到自己的工作成果。

四、    Doxygen+vim配合使用

vim的配置文件:/etc/vimrc中添加如下内容:

"let g:DoxygenToolkit_briefTag_pre="@Name: "

let g:DoxygenToolkit_paramTag_pre="@Param: "

let g:DoxygenToolkit_returnTag   ="@Returns: "

"letg:DoxygenToolkit_blockHeader="/*******************************************************"

"let g:DoxygenToolkit_blockFooter="*******************************************************/"

"let g:DoxygenToolkit_authorName="chenqin,[email protected]"

let g:DoxygenToolkit_licenseTag="Copyright (C) Infogo Technology LimitedCompany"

let g:DoxygenToolkit_briefTag_funcName="yes"

let g:doxygen_enhanced_color=1

"自定义快捷键

vmap <C-S-P>    dO#endif<Esc>PO#if 0<Esc>

map <F12> <Esc>:Dox<cr>

map <F11> <Esc>:DoxAuthor<cr>

map <F10> <Esc>:DoxLic<cr>

 

DoxAuthor:将文件名,作者,时间等关键字自动填好

DoxLic:license注释

Dox:函数及类注释 

由于我在vim配置文件中设置了快捷键,在使用过程中我只需要在把光标定位到函数第一行按下F12就可以在函数前自动生成注释了。赋图一张,图()是我在vim配置文件中添加了自动生成文件注释和使用doxygen工具生成的函数注释效果图,图(二)是生成的html网页文档效果图:

 

Linux下使用doxygen自动生成注释和文档

(图一)

 

Linux下使用doxygen自动生成注释和文档

(图二)

PS:由于最近工作比较忙,暂时只列出了这些功能,有需要的朋友可以去阅读官方提供的工具使用手册。此外,文章中部分引用了网上一些博客的文章,我加以整理并实践了,在此为谢。如文中有什么不明白的地方,可以邮件联系。