0

我正在研究编写有关某些功能的文档，但不想在源代码中编写文档。

是否有我可以遵循的模板，例如 XML，或者可以生成某种 Javadoc 风格文档的模板？

4

2 回答 2

3

有docbook，但公平地说，docbook 擅长书籍或手册样式的文档。它确实做网站文档，但它的网站往往不像 javadoc 那样紧密相连。 这是呈现给网站的 docbook 文档的示例。

当您拥有一个在现实世界中没有演示文稿的“源文档”和一些必须包含从源文档构建的正确、最新信息的“渲染文档”时，Docbook 会表现出色。

很难理解您在寻找什么，主要是因为您似乎并不确定自己。Javadoc 是专门为记录 Java 代码而设计的文档，因此“没有源代码的类似 javadoc 的文档”很难遵循。也许如果您坐下来思考文档的主要部分，您会找到一个大纲（其中可能包含您想要使用的导航）。那么填空会容易得多，因为你有空白。

您可以使用 javadoc 引擎生成文档。它是非常可配置的；并支持两种插件。一个添加额外的“标签”，一个添加/覆盖额外的“布局”。然而，这些标签和布局在一个倾向于 Java 源代码的 API 上运行，因此“类之前的 javadoc 注释”调用一个有效处理该类的 javadoc 的方法。因此，如果没有 Java 源代码（或类似的源代码），您将拥有错误的底层 API（除非您可以根据需要对其进行调整）。

于 2012-10-15T15:30:07.450 回答
2

也许您正在寻找类似Doxygen的东西，这是一个 API 文档工具，也可用于编写其他文档（例如，doxygen 的手册是用 Doxygen 本身制作的，没有正常的源代码。）

另一个工具是Sphinx，它也可以用于 API 文档以及没有源代码的手册（例如：Python 文档）。

于 2012-10-15T15:53:54.523 回答