创建没有源代码的javadoc样式文档

Question

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

是否有我可以遵循的模板，例如XML，或者可以生成某种Javadoc-ish外观样式文档的东西？

Answer 1

有docbook，但公平地说，docbook擅长书籍或手册风格的文档。它确实做了网站文档，但它的网站往往不像javadoc那样密切相关。提交给网站的docbook文档的This is an example。

如果您有一个在现实世界中没有演示文稿的“源文档”，以及一些所有必须包含从源文档构建的正确，最新信息的“渲染文档”，Docbook都会擅长。

很难理解你在寻找什么，主要是因为你似乎并不完全确定自己。 Javadoc是专门用于记录Java代码的文档，因此“没有源代码的文档的javadoc”是一个难以理解的想法。也许如果你坐下来思考文档的主要部分，你会发现一个大纲（可能包括你想要使用的导航）。然后填写空白会容易得多，因为你有空白。

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

Answer 2

也许你正在寻找类似Doxygen的东西，这是一种API文档工具，也可用于编写其他文档（例如，doxygen手册是在没有正常源代码的情况下使用Doxygen生成的。）

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