程序文档工具NWire、ZoeeyDoc、pydoctor、DoctorJ介绍

以下为你介绍的程序文档工具都可用在Linux系统上:NWire(帮助Java开发者更清晰的阅读代码)、ZoeeyDoc(DocBook文档构建工具)、pydoctor(API 文档工具)、DoctorJ(Java文档分析工具)。

1、NWire(帮助Java开发者更清晰的阅读代码)

程序文档工具NWire、ZoeeyDoc、pydoctor、DoctorJ介绍

nWire可以帮助Java开发者更清晰的阅读代码,提高编程效率。通常程序员分析代码所花费的时间比编写代码更长,通过集中查看程序组件和相互关联,再加上独特的搜索和可视化工具,可以使编程效率大大提高。

现代Java程序都依附于标准架构和设计模式。nWire提供了一个独特的视角,通过它可以知道一个组件(比如类或接口)是如何插入到工程架构中的,并可以 知道其依赖关系从而避免bug出现。nWire让初学者学习Java变得简单,可以让程序员更轻松的修改别人编写的代码,而且非常适合进行软件外包开发。

nWire提供了一些特有的工具:

nWire Navigator——一个用来浏览程序代码中各种形式的关联(association)的工具:包括类型继承、接口实现、方法调用等。

nWire QuickSearch—可用来搜索系统中的各种元素,包括方法和字段。

nWire Visualizer——图形化显示系统元素,并将它们之间的关联表示出来。

nWire支持带JDT的Eclipse 3.4和3.3。支持Windows XP/Vista,Mac OS X和Linux平台。

nWire Software公司是一个独立的软件供应商,专注于开发Eclipse平台下的软件开发工具。nWire Software希望能通过向用户提供简单实用的工具来帮助他们提高开发效率。nWire Software公司于2007年建立,总部在以色列的特拉维夫。

nWire可以比较清楚的看出继承、使用的包、方法、常量及接口,而且在点击之后会继续显示。

并且可以可视化显示类的关系,通过点击右上角的”Open Visualization View”。

使用”Ctrl+5”可以进行搜索,会自动匹配。

nWire使用体验及评价:

代码辅助软件主要要有类继承派生关系可视化显示功能,nWire做的很不错。

搜索功能同样强大,预览实在是太棒了。

nWire分析编译速度太慢,每次启动eclipse都要等5,6分钟。

个人用户及非盈利团体免费获得nWire的方法:

个人用户可以通过推广获得。

非盈利用户可以通过联系客服获得免费版本。

总体来讲在这次试用中,nWire给我的感觉还是相当不错的,但是任何工具软件都只是工具,真正使它们发挥作用的还是人。

2、ZoeeyDoc(DocBook文档构建工具)

ZoeeyDoc是一个DocBook文档构建工具,支持single-html、html、chm、pdf等格式导出,对中文支持良好。

优点:

纯文本格式:基于xml,纯文本格式方便版本控制。章节可分为独立的文件和目录进行编辑。

多格式发布:经过一次书写便可以输出html、chm、pdf等众多格式,极大的方便了阅读。

排版格式:排版格式精良。DocBook与专业排版工具TeX实力相当。常用来制作出版发行物、专业论文、软件手册等。

格式规范:纯xml格式,有众多编辑工具,格式规范便于自动检验。

中文支持:良好的中文支持自动引用系统字体生成pdf所需的字体描述文件。

自动化支持:采用纯命令行形式,可方便的加入到各类自动构建工具中。

人工服务:本地化,中文在线问题疑难解答。

其他:生成single-html、html等格式会自动打包为zip文件。且zip、pdf、chm等文件会自动生成checksum 校验文件。

3、pydoctor(API 文档工具)

pydoctor 是一个 Python 实现的 API 文档工具,可解析 Python 源码文件和模块和包的语法树并生成相应的说明文档,有点类似 JavaDoc。

安装:

pip install pydoctor

下载地址:https://launchpad.net/pydoctor/

4、DoctorJ(Java文档分析工具)

DoctorJ 是一个用来分析 Java 文档的工具,其精度和复杂度基于源码级别,超过了 javadoc 的功能。

DoctorJ查找Javadoc工具没有的疏漏、错误和常见错误。

下载地址:https://sourceforge.net/projects/doctorj/

注明

以上就是程序文档工具NWire、ZoeeyDoc、pydoctor、DoctorJ的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章