程序文档工具Go Walker、Docco、CodeQuery、GNU texinfo介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Go Walker(Go 项目 API 在线文档)、Docco(文档生成器)、CodeQuery(代码检索工具)、GNU texinfo(文档系统)。

1、Go Walker(Go 项目 API 在线文档)

程序文档工具Go Walker、Docco、CodeQuery、GNU texinfo介绍

Go Walker 是一个用于在线生成并浏览 Go 项目 API 文档及黑客视图的 Web 服务器,目前已支持包括 Bitbucket、GitHub、Google Code、Launchpad 和 Git @ OSC 在内的五大代码托管平台。

主要特性:

在海量项目中搜索并查看文档。

通过在搜索框中输入外部包的导入路径或关键字进行搜索或在线生成文档。

在线生成 Go 项目文档:不需要附加安装任何组件即可开始使用。

根据项目 Tags 查看不同版本的文档:不用为使用旧版本而担忧。

对于当前包的函数和方法拥有一键查看代码快速浏览功能。

当前包中函数、方法和类型拥有鼠标悬浮提示和跳转链接的便捷功能。

对于外部包的函数、方法和类型拥有代码高亮和跳转链接的便捷功能。

键盘快捷键呼出控制面板以及实现更多功能。

使用标签标记项目:更好地分类显示。

多语言支持。

通过 Github Gist 为您喜爱的项目增加第三方示例。

基于源文件的代码浏览。

下载地址:https://gowalker.org/

2、Docco(文档生成器)

Docco 是一个应急用的文档生成器。使用 Literate CoffeeScript 编写。可生成 HTML 文档来显示你在代码中的注释。使用 Markdown 语法,代码通过 Pygments 语法高亮。

Docco可用于处理以任何编程语言编写的代码。如果尚未处理您的收藏夹,请随时将其添加到列表中。最后,还支持languages.json中列出的任何语言的文学风格,只需在末尾添加.md扩展名:.coffee.md,.py.md等。

如果Node.js不在您的平台上运行,或者您希望使用更方便的软件包,请获取Ryan Tomayko的Rocco,它是作为gem提供的Ruby端口。如果您正在编写shell脚本,请尝试一下Shocco,它也是POSIX shell的端口,也是Tomayko先生写的。如果您想提高Python的速度,请看看Nick Fitzgerald的Pycco。

使用npm安装Docco:

sudo npm install -g docco

针对您的代码运行它:

docco src/*.coffee

3、CodeQuery(代码检索工具)

程序文档工具Go Walker、Docco、CodeQuery、GNU texinfo介绍

CodeQuery 是一个用来搜索 C/C++、Java 源码的索引工具。基于 cscope 和 ctags 构建,使用 cqmakedb 工具来生成 CodeQuery 数据库文件,然后通过 GUI 工具进行查看。

支持搜索:符号、函数、宏、类、结构体等等。

这是一个索引,然后查询或搜索C、C++、Java、Python、Ruby、Go和Javascript源代码的工具。它基于cscope和Exuberant ctags的数据库。它也可以与Universal ctags一起使用,Universal ctags可以替代Exuberant ctags。cscope和ctags的数据库将由cqmakedb工具处理以生成CodeQuery数据库文件。可以使用codequery GUI工具查看和查询CodeQuery数据库文件。

CodeQuery具有的功能:

结合了cscope和ctag的优点。

由于在CodeQuery数据库中使用了sqlite,因此速度更快。

跨平台GUI工具。

快速自动完成搜索词。

不区分大小写的部分关键字搜索-支持通配符搜索*和?。

完全匹配搜索。

按文件路径过滤搜索结果。

具有语法高亮显示的文件查看器,用于UTF-8编码的源文件。

能够在外部编辑器或IDE中打开查看的文件。

基于搜索词的函数调用图和类继承的可视化。

可视化图可以保存为PNG或Graphviz DOT文件。

下载地址:http://ruben2020.github.io/codequery/

4、GNU texinfo(文档系统)

Texinfo是GNU项目的官方文档格式,它是由Richard Stallman和Bob Chassell于多年前发明的,大致基于Brian Reid的Scribe和当时的其他格式化语言。许多非GNU项目也使用它。

Texinfo使用单个源文件来生成多种在线和打印格式的输出(dvi、html、info、pdf、xml等)。这意味着您无需编写用于在线信息的其他文档和用于印刷手册的其他文档,而只需要编写一个文档。 而且,当修改工作时,您只需要修改那个文件。Texinfo系统与GNU Emacs很好地集成在一起。

下载地址:https://www.gnu.org/software/texinfo/

注明

以上就是程序文档工具Go Walker、Docco、CodeQuery、GNU texinfo的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章