问题描述
|
关闭。这个问题是基于意见的。它当前不接受答案。
解决方法
这取决于您的听众是谁。
如果您的读者将主要使用API，那么通常最好在Javadoc中投入简洁明了的描述（包括示例）。如果听众可能从未看过API，那么最好将文档保留在Javadoc之外。这是文档导航的主要功能。 Javadoc导航简化了编程过程。
至于您希望将文档放在Wiki还是PDF中，这又取决于听众。如果Wiki的唯一原因是使用面向Web的文档HTML表示形式，则使用类似于Docbook的方法可能会为此类文档提供额外的好处，即能够生成相同文档的PDF表示形式。如果您确实有一个活跃的社区，那么Wiki可以让陌生人修改您的文档。
确定产品的强度是否符合您的需求，如果符合，则是正确的选择。
, Javadoc非常适合生成API级别的文档。我使用Wiki作为高级文档。我使用融合作为我的Wiki，并且有一些插件可用于体系结构图。