eclipse/myeclipse注释模板的修改(转载)

转载: http://hi.baidu.com/lingyu125/blog/item/69eeb2c76247da169d163ddd.html

 

 

注释比代码还重要？？ 
当然！在一个项目的完整的生命周期中，其维护费用，往往是其开发费用的数倍。 
因此项目的可维护性、可复用性是衡量一个项目好坏的关键。而注释则是可维护性中必不可少的一环。 

Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit 

/**   
*    
* 项目名称：${project_name}   
* 类名称：${type_name}   
* 类描述：   
* 创建人：${user}   
* 创建时间：${date} ${time}   
* 修改人：${user}   
* 修改时间：${date} ${time}   
* 修改备注：   
* @version    
*    
*/ 

或者： 
右边点Import 选择你写好的模板.xml文件 

导入进去即可 

使用方法： 
创建新类的时候，勾上“Generate comments”选项即可。新创建的类中，自动添加了你的注释模板中定义好了的注释。 

下面是一个注释行模板codetemplates.xml，可以直接导入使用。贴出源码供大家参考一下 
<?xml version="1.0" encoding="UTF-8"?><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"> 
/**   
* 创建一个新的实例 ${enclosing_type}.   
*   
* ${tags}   
*/</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="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**   

* ${enclosing_method}(这里用一句话描述这个方法的作用)   

* TODO(这里描述这个方法适用条件 – 可选)   

* TODO(这里描述这个方法的执行流程 – 可选)   

* TODO(这里描述这个方法的使用方法 – 可选)   

* TODO(这里描述这个方法的注意事项 – 可选)   

* @param   name   

* @param @return    设定文件   

* @return String    DOM对象   

* @Exception 异常对象   

* @since CodingExample　Ver(编码范例查看) 1.1   

*/</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="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**   
* 文件名：${file_name}   
*   
* 版本信息：   
* 日期：${date}   
* Copyright 足下 Corporation ${year}    
* 版权所有   
*   
*/</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">/**   
* ${bare_field_name}   
*   
* @return the ${bare_field_name}   
* @since   CodingExample Ver(编码范例查看) 1.0   
*/   
</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}:${todo}（用一句话描述这个变量表示什么）   
*   
* @since Ver 1.1   
*/   
</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">/**   
*    
* 项目名称：${project_name}   
* 类名称：${type_name}   
* 类描述：   
* 创建人：${user}   
* 创建时间：${date} ${time}   
* 修改人：${user}   
* 修改时间：${date} ${time}   
* 修改备注：   
* @version    
*    
*/</template></templates> 




行注释： 
安装方法： 
打开eclipse/myeclipse 
选择 window-->Preferences-->JAVA-->Code-->Code Templates 右边点Import 选择你写好的模板.xml文件 

导入进去即可 

使用方法： 
创建新类的时候，勾上“Generate comments”选项即可。新创建的类中，自动添加了你的注释模板中定义好了的注释。 

下面是一个注释行模板codetemplates.xml，可以直接导入使用。贴出源码供大家参考一下 


view plaincopy to clipboardprint? 
<?xml version="1.0" encoding="UTF-8"?><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"> 
/**   
* 创建一个新的实例 ${enclosing_type}.   
*   
* ${tags}   
*/</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="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**   

* ${enclosing_method}(这里用一句话描述这个方法的作用)   

* TODO(这里描述这个方法适用条件 – 可选)   

* TODO(这里描述这个方法的执行流程 – 可选)   

* TODO(这里描述这个方法的使用方法 – 可选)   

* TODO(这里描述这个方法的注意事项 – 可选)   

* @param   name   

* @param @return    设定文件   

* @return String    DOM对象   

* @Exception 异常对象   

* @since CodingExample　Ver(编码范例查看) 1.1   

*/</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="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**   
* 文件名：${file_name}   
*   
* 版本信息：   
* 日期：${date}   
* Copyright 足下 Corporation ${year}    
* 版权所有   
*   
*/</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">/**   
* ${bare_field_name}   
*   
* @return the ${bare_field_name}   
* @since   CodingExample Ver(编码范例查看) 1.0   
*/   
</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}:${todo}（用一句话描述这个变量表示什么）   
*   
* @since Ver 1.1   
*/   
</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">/**   
*    
* 项目名称：${project_name}   
* 类名称：${type_name}   
* 类描述：   
* 创建人：${user}   
* 创建时间：${date} ${time}   
* 修改人：${user}   
* 修改时间：${date} ${time}   
* 修改备注：   
* @version    
*    
*/</template></templates>