是否有使用类似Wiki的语法的javadoc替换？

Question

是否有一个工具用更多的Wiki风格的语法代替javadoc,而不是普通JavaDoc的HTMLish语法？

我的一个问题是我主要以源代码形式阅读JavaDoc.即使对于外部库,我也尝试连接源代码,这样我就可以从IDE导航到它,检查入口点上方的文档,如果需要,还可以查看下面的代码.

另一个问题是列表和代码示例之类的内容很难写,特别是如果你的IDE坚持在每一行都放置星标.我希望看到的是使用一种Wiki语法,至少具有以下功能:

• 名单
• 代码块
• 交联到方法/类

还有很多东西会很好,但我相信这些都是必需品.

有谁知道这样的工具？

Answer 1

有一个名为WikiDoclet的项目，我从未使用过它，但我很想知道您对它的看法。

从网站：

这是 Java JDK 提供的标准 javadoc doclet 的扩展。它增加了对我所说的 Wiki 格式的支持。这意味着您的 JavaDoc 现在可以使用文本规则进行格式化，这些文本规则比 JavaDoc 中嵌入的 html 更容易查看。例如，要强调一段文本，请用星星将其包围起来。带下划线的斜体。当运行 doclet 来生成 JavaDoc 时，将评估这些规则并进行 html 替换。这种格式应该使阅读 java 源代码变得更加容易，因为它不再被 HTML 标签弄乱。对于项目符号列表和表格尤其如此。HTML 仍然保留，因此您可以根据需要进行混合和匹配。

对于其他 doclet 格式，请查看doclet.com。