至于您希望将文档放在 wiki 还是 PDF 中，这又取决于受众。如果 wiki 的唯一原因是拥有面向 Web 的文档 HTML 表示形式，那么使用类似于 Docbook 的内容可能会为此类文档提供额外的好处，即能够生成同一文档的 PDF 表示形式。如果您确实拥有一个活跃的社区，那么 wiki 的亮点在于允许陌生人修改您的文档。
确定产品的优势是否符合您的需求，如果符合，那么它就是正确的选择。
It depends on who your audience is.
If your audience is going to be primarily using the API, it is generally better to invest in clear concise descriptions (with examples) in your Javadoc. If the audience is likely to never see the API, then it is better to maintain your documentation outside of Javadoc. This is primary a function of how the documentation is navigated; Javadoc navigation facilitates the programming process.
As for whether you wish to put the documentation in a wiki or in a PDF, again it depends on the audience. If the only reason for wiki is to have a web facing HTML representation of the documentation, using something similar to Docbook might provide such documentation with the added benefit of ability to generate PDF representations of the same documentation. If you really have an active community, wiki shines in the ability of allowing near-strangers to modify your documentation.
Determine if the strengths of the products align with your needs, and if they do, then it's the right choice.
Javadoc 非常适合生成 API 级文档。我使用 wiki 来获取高级文档。我使用 confluence 作为我的 wiki，并且有一些插件可以用于架构图。
Javadoc is great for generating API level documentation. I use a wiki for my high level documentation. I use confluence as my wiki and there are a few plugins you can use for architectural diagrams.
发布评论
评论（2）
这取决于你的观众是谁。
如果您的受众主要使用 API，那么通常最好在 Javadoc 中投入清晰简洁的描述（带有示例）。如果受众可能永远不会看到 API，那么最好在 Javadoc 之外维护您的文档。这是文档导航方式的主要功能； Javadoc 导航有利于编程过程。
至于您希望将文档放在 wiki 还是 PDF 中，这又取决于受众。如果 wiki 的唯一原因是拥有面向 Web 的文档 HTML 表示形式，那么使用类似于 Docbook 的内容可能会为此类文档提供额外的好处，即能够生成同一文档的 PDF 表示形式。如果您确实拥有一个活跃的社区，那么 wiki 的亮点在于允许陌生人修改您的文档。
确定产品的优势是否符合您的需求，如果符合，那么它就是正确的选择。
It depends on who your audience is.
If your audience is going to be primarily using the API, it is generally better to invest in clear concise descriptions (with examples) in your Javadoc. If the audience is likely to never see the API, then it is better to maintain your documentation outside of Javadoc. This is primary a function of how the documentation is navigated; Javadoc navigation facilitates the programming process.
As for whether you wish to put the documentation in a wiki or in a PDF, again it depends on the audience. If the only reason for wiki is to have a web facing HTML representation of the documentation, using something similar to Docbook might provide such documentation with the added benefit of ability to generate PDF representations of the same documentation. If you really have an active community, wiki shines in the ability of allowing near-strangers to modify your documentation.
Determine if the strengths of the products align with your needs, and if they do, then it's the right choice.
Javadoc 非常适合生成 API 级文档。我使用 wiki 来获取高级文档。我使用 confluence 作为我的 wiki，并且有一些插件可以用于架构图。
Javadoc is great for generating API level documentation. I use a wiki for my high level documentation. I use confluence as my wiki and there are a few plugins you can use for architectural diagrams.