程序文档工具XDoclet、ext-doc、chmc、Glyph介绍

以下为你介绍的程序文档工具都可用在Linux系统上:XDoclet(通用的代码生成实用程序)、ext-doc(JavaScript文档生成工具)、chmc(CHM编译器)、Glyph(Ruby文档框架)。

1、XDoclet(通用的代码生成实用程序)

程序文档工具XDoclet、ext-doc、chmc、Glyph介绍

XDoclet 是一个通用的代码生成实用程序,是一个扩展的Javadoc Doclet引擎(现已与Javadoc Doclet独立),XDoclet是EJBDoclet的后继者,而EJBDoclet是由Rickard Oberg发起的。它允许您使用象 JavaDoc 标记之类的东西来向诸如类、方法和字段之类的语言特征添加元数据。随后,它利用这些额外的元数据来生成诸如部署描述符和源代码之类的相关文件。可以让你创建自己的javadoc @tags进而利用XDoclet中的Templet enging基于这些@tags生成源代码或其他文件(例如xml的deployment descriptors)。

XDoclet 继承了 JavaDoc 引擎的思想,允许根据定制 JavaDoc 标记生成代码和其他文件。当然,XDoclet 也可以访问整个解析树。这样,它就可以访问类、类的包结构和类的方法。

XDoclet 提供了自己的模板引擎。该模板引擎在概念上类似于 JavaServer Pages(JSP)技术。它实质上包含两类标记:块标记(block tag)和内容标记(content tag)。块标记控制如 Java 编程语言中的 if 和 for 语句之类的流。内容标记打印当前解析树上下文的片段,如类名称、方法名称和参数,等等。

好处:

您无需担心只要触摸代码就约会部署元数据。部署元数据不断集成。

每个组件仅处理一个文件,就可以更好地了解正在执行的操作。如果您的组件由多个文件组成,则很容易丢失跟踪。如果您曾经编写过Enterprise Java Bean,您就会知道我们的意思。单个EJB通常可以包含7个或更多文件。使用XDoclet,您只需维护其中一个,其余的就生成了。

您可以大大减少开发时间,并且可以专注于业务逻辑,而XDoclet会为您生成85%的代码。

削减冗余工作,XDoclet可帮助您消除多余的工作。对您的业务逻辑进行编码,然后让XDoclet生成必要的样板并为其提供支持代码。

J2EE变得容易,XDoclet的高级代码生成功能使对J2EE应用程序进行编码变得更加容易。您编写了企业bean实现,XDoclet会为您生成接口,值对象,struts表单等等。XDoclet遵循许多公认的J2EE模式。

支持领先的服务器和工具,XDoclet捆绑了适用于所有主要应用程序服务器的模块:JBoss,BEA WebLogic,IBM WebSphere,Oracle IAS,Orion,Borland,MacroMedia JRun,Jonas,Pramati,Sybase EAServer等。支持的工具:Castor,Hibernate,一些JDO供应商,Struts,WebWork,MockObjects等。

可扩展,XDoclet的模块化设计使您可以轻松编写自己的模块。在应用程序中标识可重复的代码或样板代码,并编写XDoclet模板以生成它们。

开放的分布式开发,XDoclet由世界各地的专家组开发,并根据灵活的BSD许可证进行分发。通过使用XDoclet避免供应商锁定。同样,XDoclet开发的分布式特性确保了它可以满足大多数用户的需求。

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

2、ext-doc(JavaScript文档生成工具)

程序文档工具XDoclet、ext-doc、chmc、Glyph介绍

ext-doc 是一个JavaScript API 文档生成工具,它能够根据 JavaScript 源文件生成基于ExtJS 模板风格的API 说明文档。

3、chmc(CHM编译器)

chmc 是一个在 Linux/Unix 下用来编译 CHM 帮助文件的编译工具。

4、Glyph(Ruby文档框架)

程序文档工具XDoclet、ext-doc、chmc、Glyph介绍

Glyph 是一个 Ruby Document Authoring 框架,如果把 Ruby On Rails理解成生成文本文件的框架text documents 给网站的话,用Glyph框架就可以生成pdf或html格式文件。

使用Glyph,创建和维护任何类型的文档都变得像编程一样容易。通过Glyph,您可以通过一种简单但有效的宏语言(专门针对自定义和可扩展性)来最大程度地减少文本重复,专注于内容。

安装方法:

gem install glyph

以下是一些示例命令:

glyph init-在当前(空)目录中初始化一个新的Glyph项目。

glyph add introduction.textile-创建一个名为Introduction.textile的新文件。

glyph compile-将当前文档编译为单个HTML文件。

glyph compile --auto-每次文件更改时都继续重新编译当前文档。

glyph compile -f pdf-将当前文档编译为HTML,然后将其转换为PDF。

glyph compile readme.glyph-将位于当前目录中的readme.glyph编译为单个HTML文件。

glyph outline -l 2-显示文档轮廓,最多显示第二级标题。

glyph stats-显示项目统计信息。

下载地址:https://h3rald.com/glyph/

注明

以上就是程序文档工具XDoclet、ext-doc、chmc、Glyph的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章