2009-09-21 14 views
11

有没有一种工具取代javadoc的东西,而不是正常的JavaDoc的HTMLish语法更多的Wiki风格的语法?是否有一个使用维基语法的javadoc替换?

我的一个问题是我大部分都是以源代码的形式读取JavaDoc。即使对于外部库,我也尝试添加源代码,以便从我的IDE中导航到源代码,检查入口点上方的文档以及下面的代码。

另一个问题是,像列表和代码示例这样的东西很难写,特别是如果你的IDE坚持要在每一行放上星星。我想看到的东西,用一种wiki语法与至少以下特点:

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

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

有谁知道这样的工具?

+0

代码块都差不太多与'{@code}'。我认为'{@link}'很适合链接到会员和类型。 – 2009-09-22 00:06:19

+0

当你在考虑维基风格的显示时,如果你可以编辑维基风格,并且将它推回到评论中,那将是非常不错的。我怀疑这是多少要求。 – Carl 2009-09-22 02:28:52

回答

3

有一个项目叫做WikiDoclet,我从来没有用过它,但我很想看看你对它的看法。

从网站:

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

对于其它doclet,格式,请doclet.com

+0

不错的链接 - 谢谢。我会给它一个镜头。 – 2009-09-23 04:42:31

相关问题