分类: LINUX
2009-07-08 17:09:28
目前,网上所能搜到 Doxygen 资料,大都是介绍 C++ 程序文档生成的,对于 C 程序的文档生成鲜有记述。由于我们的项目主要是采用 C 语言实现,这两天在学习使用 Doxygen 制作 C 程序文档时,摸索了一点东西出来,记之备忘。
我们在写程序时,通常会在源码中适当之处添加合理的注释,以此来说明代码所能实现的功能、使用约定等信息。如果在撰写代码注释时,能够稍微遵从某种格式,然后采用某种工具,根据源码结构及注释自动生成排版美观的文档,这将大大减轻我们的工作量,使我们多一些时间享受生命。 Doxygen 就是这样一种工具。
关于 Doxygen 更为详尽的介绍,请阅读其。
几乎所有的 GNU/Linux 发行版的软件仓库中都可以找到 Doxygen,有些发行版默认已经安装,安装前请检查一下。
如果你打算在 Windows 环境中使用 Doxygen,我会劝说你删除 Windows -> 安装一个 GNU/Linux -> 安装 Doxygen,如果你非要坚持在 Windows 环境中使用 Doxygen,那我只好告诉你:去 下载一个 Win 版本的 Doxygen,然后双击所下载的安装文件,然后 Next … Next …
Doxygen 的工作过程可分为三个步骤:
在 Doxygen 手册页上可以看到一份很详细的 。对于我而言,仅仅需要 Doxygen 完成以下流程即可满足我的需求。
为了更好的学习 Doxygen,构造了一个很小型的“项目”,为了叙述的方便,给它取个名字——“M2 List”,其内容是我从我们的项目中的双向链表模块抽取出来的。
M2 List 项目的目录结构如下图所示:
M2 List 程序目录为 m2-list,src 目录用于放置程序源文档,example 用于放置测试程序,lib 用于放置最终生成的 M2 List 共享库文件。
下面讲述如何使用 Doxygen 为 M2 List 项目生成文档。
Doxygen 工作环境的配置貌似非常复杂,配置文件中的选项有数百项之多,不过其中的绝大多数不需理会,采用 Doxygen 配置文件模板中定义的默认值即可。
进入 m2-list 目录,使用 "doxygen -g" 命令生成 Doxygen 配置文件模板:
默认生成的配置文件名为 "Doxyfile",也可以采用 "doxygen -g your-cfg-filename" 命令格式指定所生成的配置文件名。如无特殊需要,采用默认的配置文件名即可。
Doxyfile 文件内容非常多,大概 1000 多行,不过其中约 4/5 都是注释,每个配置选项都有一段详细的注释。日后,如果对 Doxygen 各配置选项的意义有一定了解,可以在生成配置文件的命令中添加 "-s" 选项,生成不含注释的配置文件,操作如下:
为实现本文目的,对默认生成的 Doxygen 配置文件需要有针对性的调整,使之适于 C 程序文档生成。下面给出我认为重要的几个配置选项及相应设置:
可以下载我的配置文档作为参考: 。
欲详知 Doxygen 各配置选项的作用,请阅读 doxygen 手册中的 config.html 页面 (通常位于 /usr/share/doc/doxygen*/html/config.html)。
准备好 Doxygen 的工作环境后,就需要根据 Doxygen 所定义的注释规则,对程序源码进行文档化。换句话说,就是在对程序源码添加注释时,要按照 Doxygen 的游戏规则来搞。
Doxygen 的注释类型可分为:
Doxygen 认可的行间注释标记见下例:
Doxygen 认可的行内注释标记见下例:
请仔细观察以上注释示例中所使用的注释标记。Doxygen 也允许使用其它类型的注释标记,但是我们通常没必要知道茴香豆的“茴”字有几种写法,只需要知道一种就可以了。
下面回顾一下 C 程序源码中的注释类型:
我总觉得自己在不停的说着废话,最直接了当的做法就是停下唠叨,参照 doxygen 手册中的 commands.html 页面,阅读下面的示例文档,它们都是 .h 文件。当然,在 .c 文件中也允许出现注释,但我认为它们不应该出现在程序文档中,使用 C 语言最重要的一个原则就是:.h 文件是用来声明的,类似于文章的目录或索引;而 .c 文件是用来实现的,类似文章的正文。
我的文档化后的程序源码:|。
现在开始生成程序文档,将终端的工作目录定位在 m2-list 目录,然后键入:
your-cfg-filename 是 Step 1 中生成的 Doxygen 配置文件名,如果是使用 "doxygen -g" 生成的配置文件——Doxyfile,那么可以在终端里仅键入 "doxygen" 命令即可生成程序文档。
生成的文档位于 m2-list/doc/html 目录中,使用浏览器打开该目录中的 index.html 文件,即可看到自己的工作成果。
本文仅仅是个很小很小的开始,许多我很想说的东西,由于拙于 & 懒于表达,都没有讲出来。如果这篇文章能够引起你对 Doxygen 的兴趣,并尝试在工作中使用它,我就心满意足了。实际上,Doxygen 给我的帮助不仅仅是生成程序文档,更重要的是它提示我应该怎样对程序进行良好的注释!
最后,要感谢 Doxygen 的开发者,说中文也许你们听不懂,那我 say 一句 “tks a lot”.