Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

时间:2024-03-14 17:02:27

给类注释或者方法注释肯定要有的,但是系统自带的又很不适用,那怎么办呢?看下方

类注释模板

第一种方法

打开Android Studio后,点击File -> Settings -> Editor -> File and Code Templates

接下来在右边的四个页卡中选择第二个,如图
Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

这个就是添加类头部注释了,在下方有一个Description,里面有一些你可以在注释模板中引用的变量,图中的模板就是我自己添加的,最终使用后的在类中的样子如下
Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

第二种方法

还有一种应用范围更大的添加注释模板方法

打开Android Studio后,点击File -> Settings -> Editor -> Live Template
如图

Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

点击上面的+ 号,选择Templates Group ,然后输入名称,比如我这里输入mango

接下来点中这一行,再点击+号,选择Live Templates ,这样就会在刚点中的那一行下面出现一个子行,可以添加缩写名称,比如我这里就添加了两个,一个用来给类添加注释,一个给方法添加注释的

Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

最下面有一个change,点击可以选择这个注释模板的作用域

Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

还记得上面添加的缩写名称吗,比如我这里是cc,这样当新建一个类后,在类名上面一行输入cc,就会有提示是否添加类注释,选择即可

方法注释模板

第一种方法

这跟上面给类添加注释的第二种方法一样,只要点击+号再添加一个Live Templates就行了
Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

使用方法就是在方法上面一行输入cm,就会有提示

第二种方法

这里就要用到Java Doc了,它可以把参数名,返回值信息信息都包括到注释信息中

点击File -> Settings -> Plugins -> Browse repositories

Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

然后在接下来的弹出框中搜索Java Doc,然后点击安装,然后重启Android Studio就行了
Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

最后用的话,就是在方法上面一行输入 /** 然后敲回车键就可以了

	/**
     * 
     * @param userId
     * @param listener
     */
    @Override
    public void getUserMsg(String userId, final onUserListener listener)

设置Java Doc快捷键

不仅输入 /** 可以解决注释问题,我们还可以添加快捷键

同样是打开Settings界面
Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

输入doc comment后 可以看到Fix doc comment,表示我没有输入快捷键,右键点击 选择Add Keyboard Shortcut,然后输入按键,比如我这里
Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

使用的话就是在 只要把光标放在该方法的任何一个地方,就算在方法修饰词public前面,然后按下快捷键就行了

代码风格主题

Android Studio默认的几种主题风格,个人不太喜欢,太单调,没有高亮颜色区分,这时候我们可以使用一些第三方的主题
这里推荐一个很好用的网站Code Themes

Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

喜欢哪种就下载下来,下下来是一个jar文件,接下来我们就打开Android Studio,点击

File -> Import Settings ,然后选中刚下载的文件导入就可以了,看看应用后我的代码风格

Android Studio添加自定义类注释模板 自定义方法注释模标 代码风格主题设置

其实这东西因人而异,有的人就喜欢全白的