創建沒有源代碼的javadoc樣式文檔

Question

我正在研究編寫有關某些功能的文檔，但不想在源代碼中編寫文檔。

是否有我可以遵循的模板，例如XML，或者可以生成某種Javadoc-ish樣式文檔的模板？

Answer 1

也許你正在尋找的東西像Doxygen，一個API的文檔的工具，也可以用來寫其他文檔（製作與使用Doxygen自身的doxygen的f.ex.手動不正常的源代碼。）

另一個工具是Sphinx，它也可以用於API文檔以及沒有源代碼的手冊（例如：Python文檔）。

Answer 2

還有docbook，但公平地說，docbook擅長書本或手動樣式文檔。它的確可以做網​​站文檔，但是它的網站並不像javadoc那樣嚴重相互關聯。 This is an example呈現給網站的docbook文檔。

當您有一個在現實世界中沒有演示文稿的「源文檔」，以及幾個「渲染文檔」都必須包含從源文檔構建的正確的最新信息時，Docbook纔會出類拔萃。

很難理解你在找什麼，主要是因爲你似乎並不完全確定你自己。 Javadoc是專門用於記錄Java代碼的文檔，所以「沒有源代碼的類似javadoc的文檔」是一個很難遵循的想法。也許如果你坐下來思考文檔的主要部分，你會發現一個大綱（其中可能包含你想要使用的導航）。那麼填充空白會容易得多，因爲你有空白。

您可以使用javadoc引擎生成文檔。這是非常可配置的;並支持兩種插件。一個添加額外的「標籤」，一個添加/覆蓋額外的「佈局」。但是，這些標籤和佈局在一個傾向於面向Java源代碼的API上運行，例如「在類之前的javadoc註釋」調用一個有效處理該類的javadoc的方法。因此，如果沒有Java源代碼（或者非常類似的東西），你就有了錯誤的底層API（除非你可以根據自己的需要進行調整）。