eclipse添加注释模板

时间:2021-11-08 11:11:31

写代码,一定要添加注释,一是方便自己以后使用,二是方便别人维护

注释有一定格式,反反复复敲键盘或者copy ,也有点烦。

有了注释模板,打上注释标签,自动完成注释格式,是很省心的。

把一下代码保存为xml文件:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<templates>
<template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">
/**
 *
 */</template>
 <template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">
 /**
 *  Class Name: ${file_name}
 *  Function:
 *  
 *     Modifications:   
 *  
 *  @author Howard  DateTime ${date} ${time}    
 *  @version 1.0
 *  ${tags}
 */</template>
 <template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">
 /**
 *  Function:
 *
 *  @author Howard  DateTime ${date} ${time}
 *  ${tags}
 */</template>
 <template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment"/>
 <template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">
 /**
 * ${tags}
 */</template>
 <template autoinsert="true" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">
 /* (non-Javadoc)
 * ${see_to_overridden}
 */</template>
 <template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">
 /**
 * @param ${param} 设置 ${bare_field_name}
 */</template>
 <template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">
 /**
 * ${tags}
 * ${see_to_target}
 */</template>
 <template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">
 /**
 * @return 获得 ${bare_field_name}
 */</template>
 </templates>

打开eclipse 点击window-  ------》Preference-----》java------》code style-------》code templates

导入你保存的文件

注意:在java源文件头,函数前面,或者域前面打上注释标签就自动生成格式了,然后填词就是了

一定是/**开始,否则不会生成注释,eclipse里面其他类文件也看不到注释