Pasdoc

   delphi好像一直缺个像样的源码文档生成工具，现在交流行的doxygen乱七八糟的支持下面一大串：C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D，在加上将要支持的：Perl, Ruby, Flex, Yacc,

文档代码划分 文档和代码功能划分和注意事项 文档专注于 OS 的原理和同时涉及 OS 和 Rust 特性的 Rust 语言特性，不会花篇幅来讲解 Rust 语言本身； 文档中引用的代码和代码目录中代码保持一致； 代码中书写的注释专注于功能性，不会有流程性和原理性的介绍； 文档应有全面的包括流程性、原理性和功能性的介绍。

问题内容： 我有几个已完成的较旧的PHP项目，其中包含许多我想以javadoc / phpDocumentor风格进行记录的项目。 最好是手动处理每个文件并被迫与文档一起进行代码审查，但由于时间有限，我对帮助我尽可能自动执行任务的工具感兴趣。 我正在考虑的工具理想情况下应具有以下功能： 解析一个PHP项目树，并告诉我哪里有未记录的文件，类和函数/方法（即缺少适当docblock注释的元素） 提供一

go doc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释，并生成相关文档。 它也可以作为一个提供在线文档浏览的 web 服务器，http://golang.org 就是通过这种形式实现的。 一般用法 go doc package 获取包的文档注释，例如：go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释。 go doc package/sub

字符串文档 所有重要的方法，接口，分类以及协议定义应该有伴随的注释来解释它们的用途以及如何使用。更多的例子可以看 Google 代码风格指南中的 File and Declaration Comments。 简而言之：有长的和短的两种字符串文档。 短文档适用于单行的文件，包括注释斜杠。它适合简短的函数，特别是（但不仅仅是）非 public 的 API： // Return a user-reada

See Also: 源代码中的设计文档 https://chromium.googlesource.com/chromium/src/+/master/docs/

Sphinx简单来说，是一个文档生成工具，用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处理文本的格式, 程序会自动根据源文件里的设置产生格式, 以及自动生成章节链接等工作。 和 DocBook一样，Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧，大家一定都曾有过上学时用Word痛苦地修改论文 的

目标 了解如何在 Eclipse 中创建 JAR 文件 能够将第三方代码导入您的 Java 应用程序 创建 JAR 现在您已经了解了如何编写 Java 应用程序，您可能想知道如何打包它们，以便其他开发人员可以使用它们，或者想知道如何将其他开发人员的代码导入到您的应用程序中。本单元将展示如何做。 JDK 随带了一个称为 JAR 的工具，它表示 Java Archive（Java 存档文件）。您可以使

实体可以用来作这件事情 有两个文件一个是主文件docbook.xml，包含文件头和文档信息；另一个文件file.xml是文档内容，主文件如下： <?xml version='1.0' encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5/zh_cn" "http://www.oasis-open.org/