如何着色Javadoc评论

Question

我开始在我的项目中获得相当多的代码,这是在Android Studio中,我正在努力确保它很容易理解.我要留下很多Javadoc评论,但问题是,它们看起来都一样!它总是黑色文本,或偶尔为蓝色的TODO或粗体为param,但我的设计师希望能够为文本着色以添加额外的信息维度.我希望能够看到一块绿色,并立即知道下面的任何代码都与UI有关,而不必阅读.

我在网上的任何资源中找不到任何关于Javadoc颜色的内容,我尝试搞乱Android Studio偏好,但我只能改变所有Javadoc正文的颜色,而不是更具体的颜色.

Answer 1

在Javadoc注释,你可以使用HTML标签,如的一个子集<b></b>,<i></i>等等......特别是你可以使用<font>标签和它的color属性设置中,你的Javadoc文本将呈现的颜色.例如:

/**
 * Some UI doc:
 * <p><font color="green">
 *   UI documentation and more ...
 *   <br>more ui ...
 * </font>
 * <p>And now some tech doc:
 * <p><font color="blue">
 *   Technical documentation this way ...
 *   <br>more tech ...
 * </font>
 */
public class Test {
  ...
}

将在Android Studio中以这样的方式呈现: