程序文档工具ROBODoc、Qt文档简体翻译项目、XDOC、JAutodoc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:ROBODoc(API 文档生成工具)、Qt文档简体翻译项目(Qt Docs)、XDOC(基于Web服务的PDF 排版引擎)、JAutodoc(加上Javadoc注释的Eclipse插件)。

1、ROBODoc(API 文档生成工具)

程序文档工具ROBODoc、Qt文档简体翻译项目、XDOC、JAutodoc介绍

ROBODoc 是一个 API 文档生成工具,可从源码文件中提取注释中特定的内容并生成相应的文档。文档格式包括:HTML,LaTeX,RTF,XML DocBook,or ASCII。支持的语言包括:汇编,C,C++,Java,Perl,LISP,Occam,Tcl/Tk,Pascal,Fortran,shell scripts,HTML 和 COBOL。

ROBODoc 从源代码中提取文档,并以 HTML,RTF,TeX,XML DocBook(PDF)或 ASCII 格式对其进行格式化。

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

2、Qt文档简体翻译项目(Qt Docs)

程序文档工具ROBODoc、Qt文档简体翻译项目、XDOC、JAutodoc介绍

Qt 文档中文翻译项目,在这里您可以找到有关 Qt 的各种优秀资源的中文版本。虽然我们不能保证我们的翻译质量一定很高,但是我们保证我们的文档翻译是本着严肃认真的态度进行的。如果您有疑问或者想贡献您的一份力量,请加入我们,参加到这个项目中来。

注意:

代码请使用 <syntaxhighlight /> 标签围起来,例如:

<syntaxhighlight lang="cpp">

class Test

{

};

</syntaxhighlight>

这样是有代码高亮显示的。

具体页面请标注分类,这样能够让页面在左侧导航页面中显示。不过建议只要入口页面标注就好啦!

下载地址:http://qtdocs.sourceforge.net/

3、XDOC(基于Web服务的PDF 排版引擎)

程序文档工具ROBODoc、Qt文档简体翻译项目、XDOC、JAutodoc介绍

XDOC(mini)是XDOC的精简版,项目的主要目标是提供一个基于XML的文档描述语言,使得动态网页语言(JSP、ASP、PHP等)和模板引擎可以高效的生成PDF等版式文档。

特点:

纯Java Web应用,直接部署,无需配置。

基于HTTP服务。

与HTML完美融合,自动渲染,适合各种动态网页语言。

丰富的排版标签:段落、文字、图形、图片、表格等。

丰富的排版属性。

示例:

<!DOCTYPE html>

<html lang="zh-cn" style="height:100%">

<head>

<meta charset="utf-8" />

<title>XDOC</title>

<script type="text/javascript" src="http://localhost:8080/xdoc/xdoc.js"></script>

</head>

<body style="margin:0px;overflow:hidden;height:100%">

<script type="text/xdoc" _format="pdf" style="width:100%;height:100%">

<xdoc>

<body>

<para heading="1" lineSpacing="28">

<text valign="center" fontName="标宋" fontSize="29">欢迎使用XDOC!</text>

</para>

</body>

</xdoc>

</script>

</body>

</html>

下载地址:https://gitee.com/xdoc/xdoc

4、JAutodoc(加上Javadoc注释的Eclipse插件)

程序文档工具ROBODoc、Qt文档简体翻译项目、XDOC、JAutodoc介绍

JAutodoc是一个Eclipse插件,用于自动将Javadoc和文件头添加到源代码中,可以为Javadoc和文件头定义Velocity模板。

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

注明

以上就是程序文档工具ROBODoc、Qt文档简体翻译项目、XDOC、JAutodoc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章