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

时间:2009-09-21 23:19:31

标签: java documentation wiki javadoc

是否有一个工具将javadoc替换为更具维基风格的语法而不是普通JavaDoc的HTMLish语法?

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

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

  • 列表
  • 代码块
  • 交联到方法/类

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

有谁知道这样的工具?

2 个答案:

答案 0 :(得分:3)

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

来自网站:

  

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

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

答案 1 :(得分:3)