过了一会儿,我又回来写JavaDoc了。与此同时,我开始喜欢SO的标记,它在纯文本中比HTML更具可读性。 (即使是以前从未使用过的 back tick )。
/**
* I'm talking about things like <code>ClassName</code> here.
* <p>
* And of course the well known <code><p></code>.<br>
* Should I go on?
*/
有没有人写过一些过滤器,它会在JavaDoc工具链中将SO标记转换为HTML?
或者作为注释欢迎任何指针如何使用这样的功能编写JavaDoc扩展(如果有可用的话,我主要对接口感兴趣)。
答案 0 :(得分:23)
Javadoc似乎有一个Markdown Doclet,它可以做你想要的。
由StackOverflow-user Richard Nichols制作。他已经在上面写了a blog post,其中包括一些示例输入/输出的截图。
答案 1 :(得分:17)
MarkdownDoclet有点过时了。
对于Java 7,请使用https://github.com/Abnaxos/pegdown-doclet