Intelij 自定义代码注释初探

来源:互联网 发布:卫宁软件股票代码 编辑:程序博客网 时间:2024/06/02 01:56

通过File->Settings-Editor->File And Templates可以看到InteliJ是可以自定义代码注释模板的。

对于java-class的注释原始方式是:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end#parse("File Header.java")public class ${NAME} {}
我们发现原始方式是通过包含文件的方式来实现的,那现在来看看FileHeader.java中是如何实现的呢:
/** * Created by ${USER} on ${DATE}. */
模板下方的解释说${}这种是通过Apache Velocity实现的,具体该语法是如何来实现的没有具体研究,我们只要通过介绍实现我们的需求就可以了。网上看到可以通过${DESCRIPTION}注释来实现新建java class的时候输入文字描述,但是我讲${DESCRIPTION}放到FileHeader.java中之后发现不起作用,InteliJ是原样输出的,后来通过网页查询,看到另外一种实现方式就是不用包含文件,直接在java class的模板中将需要的注释替换文件头就可以实现。
替换后的注释内容为:
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end/** * ${DESCRIPTION} * @author duanmuxx * @create ${YEAR}-${MONTH}-${DAY} ${TIME} */public class ${NAME} {}
头疼,通过这种方式就能实现新建java class 的时候弹出"添加描述"的提示框。
不管怎样,最后还是实现了,很欣慰大笑





0 0
原创粉丝点击