程序文档工具explainshell、javadoc.chm、cdocgen、JSDuck介绍

以下为你介绍的程序文档工具都可用在Linux系统上:explainshell(从Ubuntu的manpage库中调出解释文本)、javadoc.chm(转换为 chm 文件格式)、cdocgen(自文档化工具)、JSDuck(javascript API文档生成器)。

1、explainshell(从Ubuntu的manpage库中调出解释文本)

程序文档工具explainshell、javadoc.chm、cdocgen、JSDuck介绍

注:写下命令以查看与每个参数匹配的帮助文本,尝试使用显示文档来解释其他语言。站点包含来自Ubuntu手册页存储库中第1节和第8节的29761个已解析的手册页。它用Python编写的,并使用bashlex。

以色列的Idan Kamara开发了explainshell这个非常酷的工具。在搜索框里任意输入Linux命令,系统会将命令解析,从Ubuntu的manpage库中调出解释文本。

下载地址:https://www.explainshell.com/

2、javadoc.chm(转换为 chm 文件格式)

一个可以将 JDK 生成的 apidocs 文档转换为 Microsoft HTML Help (chm) 文件格式的工具。

1].支持全文索引。

2].支持全文搜索。

3].支持最新的 JDK 8 风格的文档。

3、cdocgen(自文档化工具)

cdocgen是一个功能强大的自文档化工具,可以根据doxygen风格的注释,生成visio格式的流程图,并可以自动插入到详细设计中。

4、JSDuck(javascript API文档生成器)

程序文档工具explainshell、javadoc.chm、cdocgen、JSDuck介绍

JSDuck 是senchalabs众多开源项目中的一个,它是使用ruby 编写的javascript API文档生成器。

目前 EXTJs 文档,就是使用JSDuck 所生成。

注明

以上就是程序文档工具explainshell、javadoc.chm、cdocgen、JSDuck的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章