Eclipse注释模板

在Eclipse中，通过菜单栏上的Windows->Preferences->Java->Code Style->Code Templates就可以找到注释模板了，如下图：

Comments标签就代表Eclipse的javadoc注释模板，可以自定义，以下是我自定义的注释模板。

【Files】代表文件的注释

/**
 * @FileName ${file_name}
 * @Desciption ${todo}
 * @author ${user}
 * @date ${date}
 */

【Types】代表类的注释

/**
 * @Description ${todo}
 * @author ${user}
 * @date ${date}
 * ${tags}
 */

【Fields】代表变量类型的注释

/**
 * @Field ${field_type} ${field}
 * @Description ${todo}
 */

【Constructors】代表构造方法的注释

/**
 * @Description 创建一个新的实例 ${enclosing_type}.  
 * @author ${user}
 * @date ${date}
 * ${tags}  
 */

【Methods】代表普通方法的注释

/**  
 * @Description ${todo}
 * @author ${user}
 * @date ${date}
 * ${tags}  
 * @throws  
 */  

【Overriding methods】、【Delegate methods】、【Getters】、【Setters】等采用默认的注释模板就可以了。

Eclipse也支持通过Import导入其他人Export出来的注释模板文件，为xml格式，下面是我Export出来的注释模板文件。

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
 * @Description 创建一个新的实例 ${enclosing_type}.  
 * @author ${user}
 * @date ${date}
 * ${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="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
 * @Field ${field_type} ${field}
 * @Description ${todo}
 */</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="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**  
 * @Description ${todo}
 * @author ${user}
 * @date ${date}
 * ${tags} 
 * @throws  
 */  </template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
 * @param ${param} the ${bare_field_name} to set
 */</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">/**
 * @Description ${todo}
 * @author ${user}
 * @date ${date}
 * ${tags}
 */</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
 * @return the ${bare_field_name}
 */</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">/**
 * @FileName ${file_name}
 * @Desciption ${todo}
 * @author ${user}
 * @date ${date}
 */</template></templates>

PS：生成方法注释的快捷键为 Shift + Alt + j