java - javadoc 的 markdown 替代品，也适用于 IDE

Question

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

在 GitHub 页面上，还有一个“markdown-company-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 工具提示解析的解决方案。还有其他人有解决方案或其他想法吗？

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