程序文档工具CapraDoc、PyChmViewer、APIviz、XSLTdoc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:CapraDoc(自动化文档工具)、PyChmViewer(CHM 阅读软件)、APIviz(JavaDoc 扩展工具)、XSLTdoc(XSLT 文档生成工具)。

1、CapraDoc(自动化文档工具)

CapraDoc旨在为开发人员(主要是Web开发人员)提供一个项目自动化文档工具,类似于javadoc,但更合适于 JSP、HTML、ASP等其它文件格式。

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

2、PyChmViewer(CHM 阅读软件)

程序文档工具CapraDoc、PyChmViewer、APIviz、XSLTdoc介绍

PyChmViewer 是一个使用 Python 编写的 CHM 阅读软件,功能上大体和 KchmViewer 相近(目录、索引、搜索、书签),界面使用 PyQt 4 实现(界面和 KchmViewer 很像,是在 KchmViewer 的 UI 文件上改过来的)。

3、APIviz(JavaDoc 扩展工具)

程序文档工具CapraDoc、PyChmViewer、APIviz、XSLTdoc介绍

注:上图是用 APIviz 生成的类结构图。

APIviz 是一个 JavaDoc 的 doclet,用来扩展 Java 标准化的文档组件,它可以产生复杂的类似 UML 的 类图和包图,用以快速的了解整个 API 的结构。

4、XSLTdoc(XSLT 文档生成工具)

程序文档工具CapraDoc、PyChmViewer、APIviz、XSLTdoc介绍

XSLTdoc 是一个类似 Javadoc 用来为 XSLT 生成文档的工具。是适用于所有XSLT版本(1.0、1.1、2.0)的类似于Javadoc的工具。它定义了约定以直接在源代码中记录XSL代码元素。然后,XSLTdoc工具将这些文档元素提取出来,以构建一个由多个链接的HTML页面组成的文档,这些页面可轻松浏览文档。

XSLT源代码可用于语法突出显示。XSLTdoc是在欧洲航天局根据合同18664/04/NL/LvH资助的项目中开发的。XSLTdoc用XSLT 2.0编写,并用XSLTdoc进行了文档记录,它可以通过GPL许可证免费获得。

特征:

文档嵌入在XSL程序中。

XSLT 2.0功能的文档。

语法突出显示的源代码浏览。

生成完整的样式表文档。

生成包含和导入的样式表的文档。

布局可使用CSS样式表自定义。

网站布局基于可自定义/可互换的html模板。

新标签可轻松扩展。

在GPL许可下开源。

用XSLT编写。

安装XSLTdoc的说明:

只需将XSLTdoc分发文件解压缩到专用目标目录(通常称为XSLTdoc)中即可完成XSLTdoc的安装。

运行XSLTdoc:

XSLTdoc是用XSLT 2.0编写的。您需要XSLT 2.0处理器才能运行它。XSLTdoc的可下载软件包包括Saxonica Limited的免费版本的Saxon XSLT和XQuery Processor,这需要安装Java虚拟机才能运行。

要为一个或多个XSLT程序生成文档,您需要编写一个配置文件,其中包含生成过程所需的所有信息。配置文件是一个简单的XML文件。使用下面的模板作为您自己的配置文件的起点。没有标记强制性元素:

<?xml version="1.0" encoding="UTF-8"?>

<XSLTdocConfig>

<Title>The title used on the main page</Title>

<Introduction>

This section is copied to the main documentation page. It can include any HTML tags.

</Introduction>

<!-- 

The absolute or relative path to the target directory  where the HTML files are created. If a relative path is used it is always relative to the config file.

-->

<TargetDirectory path="../doc"/>

<!-- 

The absolute or relative path to the source directory.This is where the XSLT source files can be found.If a relative path is used it is always relative to the config file.

-->

<SourceDirectory path="./"/>

<!-- 

A list of source code files which shall be documented. Only stylesheets which are not included by another have to be listed here. The included stylesheets are found automatically by following the include or the import statements in the including stylesheet.Relative references are relative to the SourceDirectory defined above.

-->

<RootStylesheets>

<File href="xsltdoc.xsl"/>

<File href="test.xsl"/>

</RootStylesheets>

<!-- 

A list of CSS Stylesheet files which should be added to the standard CSS file included (XSLTdoc.css)

- Not mandatory

- media attribute optional.

-->

<AdditionalCSS>

<File href="print.css" media="print"/>

</AdditionalCSS>

</XSLTdocConfig>

要开始生成过程,请使用配置文件作为xsltdoc.xsl程序的输入。使用Saxon 8 XSLT处理器的命令如下所示(位于XSLTdoc安装文件夹中):

java -jar lib/saxon8.jar <configuration file> xsl/xsltdoc.xsl

HTML文档的字体,颜色和布局在两个CSS文件中定义,可以在安装的CSS文件夹中找到它们。将两个文件都复制到生成文档的文件夹中。使用ant可以轻松地自动执行此步骤。作为示例,请参见用于生成XSLTdoc文档的build.xml ant文件:

<?xml version="1.0" standalone="yes" ?>

<project name="XSLTdoc" default="xsltdoc" basedir=".">

<description>Ant Build file for the XSLTdoc program</description>

<path id="classpath">

<pathelement location="lib/saxon8.jar" />

<pathelement path="${java.class.path}" />

</path>

<target name="xsltdoc">

<delete dir="doc" />

<copy todir="doc">

<fileset dir="css">

<filename name="*.css" />

</fileset>

</copy>

<xslt force="true" style="xsl/xsltdoc.xsl" in="xsl/XSLTdocConfig.xml" out="doc/log.txt">

<!-- The target directory must be given relative to stylesheet  -->

<classpath refid="classpath" />

</xslt>

<delete dir="doc/log.txt"/>

</target>

</project>

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

注明

以上就是程序文档工具CapraDoc、PyChmViewer、APIviz、XSLTdoc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章