【问题标题】:How to color Javadoc comments如何为 Javadoc 注释着色
【发布时间】:2016-07-05 23:28:57
【问题描述】:

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

我在任何在线资源中都找不到任何关于 Javadoc 颜色的信息,我尝试弄乱 Android Studio 首选项,但我只能更改所有 Javadoc 正文文本的颜色,而不是更具体的内容。

【问题讨论】:

    标签: java android android-studio colors


    【解决方案1】:

    在 Javadoc cmets 中,您可以使用 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 中呈现如下:

    【讨论】:

    • 谢谢!我不知道你能做到这一点,这看起来绝对是朝着正确方向迈出的一步。你知道是否有办法直接在代码编辑器中渲染颜色吗?我们的想法是能够快速滚动代码并查看颜色,而不必为每件事打开文档,因为它已经在编辑器中可读。
    猜你喜欢
    • 2015-11-02
    • 2017-08-20
    • 1970-01-01
    • 2018-10-16
    • 2014-10-05
    • 2012-03-17
    • 1970-01-01
    • 2016-07-19
    • 2013-12-15
    相关资源
    最近更新 更多