java降价替换javadoc,也替换IDE
我已经找到了一个可能的解决方案,在https://dzone.com/articles/using-markdown-syntax-javadoc中描述,它基于https://github.com/Abnaxos/pegdown-doclet。 这使得降价支持可以替代在Javadoc中编写丑陋的HTML标记
在GitHub页面上,还有一个“与标记兼容的工具提示”解决方案,作为在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的宏
所以,正如上面网站所描述的,我想直接用源代码中的标记语法替换Javadoc。将其应用于示例,如下所示:
/**
* This enum gives you insight for various person characteristics.
*
* This could be the following:
*
* - introvert
* - extrovert
*
*/
public enum PersonTypes {
...
}
在Eclipse中将鼠标悬停在PersonTypes
enum上时,标记语法会丢失,因为Eclipse将其解释为Javadoc,而不是默认情况下的标记
不幸的是,我目前还没有找到为Eclipse启用标记工具提示解析的解决方案。 还有其他人有解决方案或其他想法吗
共 (0) 个答案