11
18
2009
0

Doxygen 试用评估

本站文章,皆为原创,如需转载,请注明出处,违者必究

相关信息

Doxygen 是 UNIX 上针对代码程序员提供的自动代码扫描与文档生成软件,下载地址为:

这个软件使得程序员仅仅需要添加很少的字符,就能自动生成高质量的代码文档,支持函数注释、类说明、代码交叉参考的生成等功能,额外的还可以提供 Latex 数学公式、DOT 图片的支持,当然,需要这些功能也需要安装对应的 Latex 和 Graphviz 软件包,它们的相应地址是:

面临的问题

在 Windows 下,Latex 有相应的 Windows 发行版,软件包官方也提供相应的 Windows 二进制版本,Ghostscript 也有 win32 的二进制提供,因而要想在 Windows 平台上建立完整的 Doxygen 文档开发环境并不是难事,但是对于 Latex 字体配置、包配置等方面,仍然有着许多困难之处。

在 UNIX 下,把一大堆不同的软件包堆叠在一起,让它们相互调用对方以形成一个强大的开发体系是一个很常见的现象,但是在 Windows 环境下,人们很早习惯了独立的商业软件包各自放在 Program Files 目录下,然后每个软件包都自我独立,包含所有需要的功能的全集的模式,如果想要像 Linux 上那样鱼龙混杂的工作,会显得非常邋遢,同时造成工作环境的混乱和付出更大的功夫去维护软件包而不是使用软件完成工作这个本质任务本身。

因而,为了保持工作环境的简洁,要么仍然选择使用独立的 Word 文档辅助代码的方式编写代码文档,要么放弃复杂的 Latex 公式功能而只使用最基础的 Doxygen 提供的功能,这是一个困难的选择。独立的文档将会造成代码与文档很容易相互脱离,造成一个滞后于另一个的现象,但是复杂化工作环境会付出永恒的更多的时间为代价。

Category: 程序开发 | Tags: | Read Count: 885

登录 *


loading captcha image...
(输入验证码)
or Ctrl+Enter

Host by is-Programmer.com | Power by Chito 1.3.3 beta | Theme: Aeros 2.0 by TheBuckmaker.com