Markdoc替代javadoc，也适用于IDE

Question

我已经找到了可能的解决方案，该解决方案在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 {
...
}

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

不幸的是，我目前没有找到针对Eclipse启用Markdown工具提示解析的解决方案。还有其他人有解决方案或其他想法吗？

Answer 1

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

请注意，该插件自 2017 年以来未更新，maven 插件自 2016 年以来未更新，请参见https://mvnrepository.com/artifact/ch.raffael.pegdown-doclet/pegdown-doclet