Eclipse代码注释模板——code templates

来源:互联网 发布:四级听力知乎 编辑:程序博客网 时间:2024/05/16 17:33
操作步骤:打开Window->Preferences->Java->Code Style->Code Templates

如图:

 

 

点击“Import”,导入模板codetemplates.xml文件。

 

附:codetemplates.xml文件内容

[xhtml] view plaincopy
  1. <?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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">/**  
  2.  * <b>项目名:</b>系统项目名称<br/>  
  3.  * <b>包名:</b>${package_name}<br/>  
  4.  * <b>文件名:</b>${file_name}<br/>  
  5.  * <b>版本信息:</b><br/>  
  6.  * <b>日期:</b>${date}-${time}<br/>  
  7.  * <b>Copyright (c)</b> ${year}XX公司-版权所有<br/>  
  8.  *   
  9.  */</template><template autoinsert="true" context="filecomment_context" deleted="false" description="Comment for created JavaScript files" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.filecomment" name="filecomment">/**  
  10.  *   
  11.  */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate functions" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**  
  12.  * ${tags}  
  13.  * ${see_to_target}  
  14.  */</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.typecomment" name="typecomment">/**  
  15.  * @author kin  
  16.  *  
  17.  * ${tags}  
  18.  */</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">/**  
  19.  *   
  20.  * <b>类名称:</b>${type_name}<br/>  
  21.  * <b>类描述:</b><br/>  
  22.  * <b>创建人:</b>kin<br/>  
  23.  * <b>修改人:</b>kin<br/>  
  24.  * <b>修改时间:</b>${date} ${time}<br/>  
  25.  * <b>修改备注:</b><br/>  
  26.  * @version 1.0.0<br/>  
  27.  *   
  28.  */</template><template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for vars" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**  
  29.  *   
  30.  */</template><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">  
  31. /**  
  32.  * 创建一个新的实例 ${enclosing_type}.  
  33.  *  
  34.  * ${tags}  
  35.  */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="Comment for overriding functions" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Jsdoc)  
  36.  * ${see_to_overridden}  
  37.  */</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">/**  
  38.  * @param ${param} the ${bare_field_name} to set  
  39.  */</template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.settercomment" name="settercomment">/**  
  40.  * @param ${param} the ${bare_field_name} to set  
  41.  */</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">/**  
  42.  * ${bare_field_name}  
  43.  *  
  44.  * @return  the ${bare_field_name}  
  45.  * @since   1.0.0  
  46. */  
  47. </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">/**  
  48.  * ${enclosing_method}(这里用一句话描述这个方法的作用)<br/>  
  49.  * (这里描述这个方法适用条件 – 可选)<br/>  
  50.  * ${tags}   
  51.  *${return_type}  
  52.  * @exception   
  53.  * @since  1.0.0  
  54. */</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">/**  
  55.  * ${tags}  
  56.  * ${see_to_target}  
  57.  */</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**  
  58.  * ${tags}  
  59.  */</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)  
  60.  * ${see_to_overridden}  
  61.  */</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">/**  
  62.  * ${field}:${todo}(用一句话描述这个变量表示什么)  
  63.  *  
  64.  * @since 1.0.0  
  65.  */  
  66. </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**  
  67.  * @return the ${bare_field_name}  
  68.  */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="Comment for non-overriding function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**  
  69.  * ${tags}  
  70.  */</template></templates>  

原创粉丝点击