IDEA 自定义类注释、方法注释(最可能有效的解决方法)
问题描述:
引言:网上很多这个问题的答案,但都是不完整和没有解释的,因此,自己按网上做的时候发现没有效果,为此,自己总结网上和实践得出有用的解决方法如下:
解决方案:
自定义类注释和方法注释的步骤一样,这里只说类注释。
1、找到如下位置:File -> Settings -> Editor -> Live Templates,如下图
2、先添加一个注释模板组(Template Group),这个组里面可以放多个模板,可以是类注释模板、方法注释模板等等。
3、输入模板组名,模板名随便取,点击“OK”。
4、找到你创建的模板组,然后在模板组下添加模板(Live Template),也就是你要自定义的注释了。
5、输入“模板缩写名”、“模板描述”、“模板内容”。“模板缩写名”就是你要用快捷键来使你自定义的注释出现的时候需要输入的;“模板描述”就是为了让别知道这个模板是干嘛的;“模板内容”就是你自定义的注释内容。
6、如果你需要用到一些特殊值、系统变量,比如当前系统的日期,就需要在“模板内容”里面用两个 $ 把你的变量名包裹起来。然后在“Edit variables”里设置。
举例:
下面我的date需要用到系统的日期,而不需要我手写。
7、选择我们要用这个模板时需要点击的“快捷键”。
8、⭐⭐(这一步最容易忘记,导致自定义的注释无法使用)选择我们要使用这个模板的上下文,也就是你要在哪些文件里面使用这个模板。
这里,作者是需要在Java类中用到这个注释,所以直接勾选了“Java”。
9、最后,点击“OK”,那么我们自定义的注释就完成了。
10、开始使用我们自定义的模板。
在类上空白处,先输入我们刚刚定义的“模板缩写名”,然后按下“Tab”键,那么我们自定义的注释模板就自动出现在我们的类上了,OK完成!!!