linux程序注释生成器,Linux下使用doxygen自动生成注释和文档

最新推荐文章于 2024-08-02 16:28:35 发布

Cyber FISH

最新推荐文章于 2024-08-02 16:28:35 发布

阅读量578

点赞数 1

文章标签： linux程序注释生成器

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

——chin

——2012/11/15

一、安装工具

1.获取DoxygenToolkit.vim插件

将其拷贝到如下目录:

/usr/share/vim/vim72/plugin/

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

安装：

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 installgraphviz

二、配置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

#文档版本号，可对应于项目版本号，譬如svn、cvs所生成的项目版本号

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表示输出所有的函数，但是private和static函数不属于其管制。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]; ///这是行内注释示例