javadoc的markdown替换,也适用于IDE

时间:2016-09-18 10:49:56

标签: java eclipse intellij-idea markdown javadoc

我找到了一个可能的解决方案,在https://dzone.com/articles/using-markdown-syntax-javadoc中描述,该解决方案基于https://github.com/Abnaxos/pegdown-doclet。 这使得markdown支持可以替代在javadoc中编写丑陋的HTML标记。

在github页面上,还有一个" markdown-compatible-tooltip"解决方案作为在IntelliJ中使用CTRL + Q工具提示的插件,这是50%的好。

举一个例子,Javadoc目前正在寻找:

/** * This enum gives you insight for various person characteristics. * <p> * This could be the following: * <ul> * <li>introvert</li> * <li>extrovert</li> * </ul> */ public enum PersonTypes { ... }

所以,如果你在IDE中使用工具提示/鼠标悬停在类上,那就没问题了。 然而,如果您直接在相关类中,由HTML标记和其他宏引起,则很难阅读。这只是一个非常简单的例子,没有任何Javadoc特定的宏。

因此,如上面的网站所述,我想直接用源代码中的Markdown语法替换Javadoc内容。应用于示例,这看起来像:

/** * This enum gives you insight for various person characteristics. * * This could be the following: * * - introvert * - extrovert * */ public enum PersonTypes { ... }

当在Eclipse中将鼠标悬停在PersonTypes枚举上时,Markdown语法会丢失,因为Eclipse会将其解释为Javadoc而不是默认为Markdown。

不幸的是,我目前还没有找到解决Eclipse的Markdown工具提示解析的解决方案。 有没有其他人有解决方案或其他想法?

1 个答案:

答案 0 :(得分:0)

IntelliJ有一个支持markdow javadoc的插件 https://plugins.jetbrains.com/plugin/9840-markdown-doclet-for-idea