javadoc的Stackoverflow标记

vbe*_*nce 25 markup markdown javadoc

过了一会儿,我又回来写JavaDoc了.与此同时,我开始喜欢SO的标记,它在纯文本中比HTML更具可读性.(即使是我之前从未使用过的背面,也是如此).

/**
 * I'm talking about things like <code>ClassName</code> here.
 * <p>
 * And of course the well-known <code>&lt;p&gt;</code>.<br>
 * Should I go on?
 */
Run Code Online (Sandbox Code Playgroud)

有没有人写过一些过滤器在JavaDoc工具链中将SO标记翻译成HTML?

或者作为注释,欢迎任何指针如何使用这样的功能编写JavaDoc的扩展(如果有任何可用的话,我主要对接口感兴趣).

Seb*_*olm 23

Javadoc 似乎有一个Markdown Doclet,它可以做你想要的.

它由StackOverflow用户Richard Nichols制作.他写了一篇博文,其中包括一些示例输入/输出的截图.

  • 理查德原来回答的链接,如果有人想投票的话:http://stackoverflow.com/questions/1026553/are-there-some-good-and-modern-alternatives-to-javadoc/1043720 #1043720 (4认同)

pro*_*ron 17

MarkdownDoclet有点过时了.

对于Java 7,请使用https://github.com/Abnaxos/pegdown-doclet