【发布时间】：2017-01-26 04:17:16
【问题描述】：
我已经找到了一个可能的解决方案，描述于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 工具提示解析的解决方案。 还有其他人有解决方案或其他想法吗？
【问题讨论】：
-
我不太清楚你的问题是什么？你是在问 eclipse 的 md 选项吗？？
-
我更新了问题的描述
-
Javadoc 按规范实际上是 HTML，大多数 IDE 都遵循规范而不是无数的替代方案。您所要求的内容很可能不可用，因此我建议您不要使用大多数标准工具无法很好支持的替代方案来引入复杂性，而应考虑坚持使用具有魅力的旧 Javadoc。
-
"Javadoc 确实是 HTML 规范" - 那么它是一个非常糟糕和过时的规范。 MD 是大多数和任何相同程序员更喜欢编写 javadoc 的方式。而且你的建议是不明智的，而不是推动和推动所需的改变。你喜欢的 Javadoc 对绝大多数人来说是一种烦恼，而且肯定不会“像魅力一样工作”。
-
@Marco13 阅读 渲染 HTML 很棒，但使用文本编辑器编写 HTML 是皮塔。
标签： java eclipse intellij-idea markdown javadoc