程序文档工具Javadoc Search、man2html、mantohtml、PHPDoctor介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Javadoc Search(对 JavaDoc 工具生成的 HTML 文档进行搜索)、man2html(让man转换为html文档)、mantohtml(man 帮助文档转成 html 超文本文件)、PHPDoctor(PHPDoc 工具)。

1、Javadoc Search(对 JavaDoc 工具生成的 HTML 文档进行搜索)

程序文档工具Javadoc Search、man2html、mantohtml、PHPDoctor介绍

Javadoc-search 是一个 CGI 脚本用来对 JavaDoc 工具生成的 HTML 文档进行搜索的工具。用它以按类或类成员快速提取 javadoc。可搜索类名、方法名和参数类型。

下载地址:https://sourceforge.net/projects/javadoc-search/

2、man2html(让man转换为html文档)

一款让man转换为html文档的开源applet。

3、mantohtml(man 帮助文档转成 html 超文本文件)

mantohtml (m2h) 是一个用来将 man 帮助文档转成 html 超文本文件的工具。即 mantohtml 是一个 Shell 脚本,它将 Unix man 程序的输出转换为符合 HTML 的标准。

特点:

兼容 XHTML 1.0 输出。

支持 HTML5 doctype。

支持 FreeBSD 和 Linux。

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

4、PHPDoctor(PHPDoc 工具)

程序文档工具Javadoc Search、man2html、mantohtml、PHPDoctor介绍

HPDoctor试图创建一个更简单,更快速的PHPDoc(PHP的Javadoc样式注释解析器),以生成符合标准的HTML。

它的设计着重于速度和简便性,这意味着它不具备PEAR PHPDoc程序的全部功能,但是易于配置、使用和扩展,并且应该能够从您现有的未编辑PHP生成API文档,只需几分钟即可完成代码。

特征:

运行速度快,使用PHP 4.3标记器功能来利用PHP的内部解析功能。

解析任何PHP文件,同一文件中具有多个类和函数。

简单的输出模板层,允许通过复制和编辑一些简单的PHP模板文件轻松更改输出格式。

易于安装和使用,立竿见影。

将生成没有Javadoc注释的API文档。

可与OO代码和过程代码一起使用,还可以记录全局变量和常量。

支持PHP5增强语法,包括接口。

对Sun的Javadoc规范的最小更改。

对与其他PHPDoc程序兼容的标签的更改。

关于下载说明:

可以通过运行以下命令使用Git克隆项目:

git clone git://github.com/peej/phpdoctor

要求:

由于使用了PHP tokenizer扩展,因此需要PHP 4.3.0+。默认情况下,Tokenizer内置于PHP 4.3.0中,PHPDoctor可以与启用了tokenizer扩展的旧版本PHP一起使用,但尚未经过测试,建议您升级到4.3.0+以使用此程序。

下载地址:https://www.peej.co.uk/phpdoctor/

注明

以上就是程序文档工具Javadoc Search、man2html、mantohtml、PHPDoctor的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章