文章目录
- 注释
- 1.类注释(有两种办法,选择其中一个就好)
-
- 2.方法注释
注释
1.类注释(有两种办法,选择其中一个就好)
办法一
- 路径:FIle->Settings,在搜索框搜索File and Code Templates,在Files下选择Class,可以自定义类注释格式,如下图:
- 示例:
- 将上面的注释示例复制到相应的模板上,如下图:
- 新建一个类时会自动生成:
办法二
- 路径:FIle->Settings,在搜索框搜索File and Code Templates,在Includes下选择File Header,输入示例,如下图:
2.方法注释
- 具体操作:打开File->Settings->Editor->Live Templates—>点击+号,添加一个Templates Group来放置自己快捷键,如下图:
- 起个名字:
- 选择刚刚创建的Group->再次点击+号,添加一个Live template
- 英文单词说明:
- Abbreviation:快捷键
- Description:描述该快捷键
- Template text:自定义的快捷键模板
**
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author:
* @Date: $date$
*/
- 可设置关联语言:
- 设置好Template text内容后,选择Edit variables,设置注释的关联变量
- 写个方法测试一下效果,
public void setPerson(String name, int age, String address){}
- 用法:/ + 快捷键名 + Tab键,我设置的是a,所以是 / + a + Tab 输出注释模板,效果如下图:
- 这篇方法注释文章写的很好,可以借鉴一下,互相学习。
文章链接:idea 方法注释的快捷键设置 - 此篇文章已合并到 【IntelliJ IDEA】相关设置汇总