发布时间:2025-06-27
浏览次数:0
当初我决定将栈长我使用的工具从其他平台转向IDEA时,内心充满了矛盾,经历了多次的放弃与尝试,但如今,转型算是取得了成功,我已经能够完全摆脱之前的编程环境,尽管现在我的编程频率确实大大降低了。
谈及 IDEA 的不足之处,我认为其注释的配置过程并不十分符合用户习惯。虽然设置和导入公共的自定义注释模板、格式化模板相对便捷,但在 IDEA 中操作起来却显得有些笨拙,让人感到头疼。而且,配置过程甚至显得有些复杂,甚至需要借助脚本才能完成。
闲话少叙,让我们来探讨一下 IDEA 面临的最棘手难题:如何处理自定义注释模板这一环节。
IDEA 中有以下两种配置模板。
下面介绍下这两种的使用方法。
File and Code
File和Code工具用于设定文件及代码的模板,意味着在文件创建过程中,系统会依照预设的模板自动生成相应的代码注释。
下面来演示一下如何自动生成 Java 类注释。
依次打开下面这个菜单:
> File and Code > files
该类内置了丰富的注释模板,但需自行进行配置;该类中包含的内容均为预设的intellij ideaintellij idea,其中包含了一段名为 #parse 的代码。
#parse("File Header.java")
这个 File .java 哪里来的呢?
依次打开下面这个菜单:
> File and Code > files >
其实这不过是之前在Files模板中通过parse所引用的那部分内容。在此处,File默认为空,只需在此片段中对模板进行编辑,即可,同时它支持若干预定义的变量,例如:DATE、TIME、USER等,上图中展示的是一个配置的实例。
从图表中可以观察到,该处所采用的模板设置涉及模板专用语言,其中所使用的 #parse 标识符是该语言的核心词汇。
因此,只需完成对文件的配置,Java 类的自动生成注释功能便设置完毕,此后,无论创建何种类,都会自动附上注释。
其他的文件配置方式不再撰述。
Live
Live工具适用于设置动态模板,它允许在指定区域通过缩写字母自动生成注释。以下将展示两个创建实例,分别是手动制作类注释及方法注释。
在上述演示中,我们看到了在定义类时系统会自动插入注释,若需自行添加类注释,应该如何操作呢?
首先打开 Live 菜单:
> Live
截图显示,cc 和 mc 已完成配置,输入这两个指令后,系统将自动生成相应的类注释与函数注释。
在界面的右上角位置,您会看到一个加号图标,点击该图标后,可以选择“Live”功能,接着添加一个动态模板,并按照提示依次进行内容的配置。
在 Text 文本中,被美元符号括起来的内容代表变量,对这些变量进行配置时,必须点击“编辑”按钮。
此外,还需确定模板应用的具体情境,例如,通过点击相应的链接,我们可以在Java编程语言环境中配置特定类型的模板。
方法注释和类注释配置一致,配置示例如下:
唯一的区别在于,在配置方法中的变量时,必须使用特定的表达式,这个过程相对繁琐。
groovyScript("def result=''; def params=\"${_1}将字符串中的特殊字符和空白字符去除后,将其按照逗号分隔,然后转换成列表;接着,从0开始遍历列表中的每个元素。< params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
此外,在此处的方法注释中存在一个陷阱,当运用 mc 工具时,应确保在方法内部而非外部进行操作,否则,@param 标注所输出的将不是参数的具体名称,而是一个空值。
今天咱们在深圳,得来聊聊如何设置IDEA中的文件代码模板、类以及方法的注释,至于其他细节,不妨深入探究这两个菜单功能。
如有侵权请联系删除!
Copyright © 2023 江苏优软数字科技有限公司 All Rights Reserved.正版sublime text、Codejock、IntelliJ IDEA、sketch、Mestrenova、DNAstar服务提供商
13262879759
微信二维码