myeclipse中java文件头注释格式设置

wylc123 1年前 ⋅ 505 阅读

myeclipse中java文件头注释格式设置 
2011-10-08 13:11:33|  分类： IDE |举报 |字号 订阅
windows->preferences->java->Code Templates->comments->Type->edit
Eclipse注释规范模版总结
新建类文件
/**
 * @ClassName:     ${file_name}
 * @Description:   ${todo}(用一句话描述该文件做什么)
 *
 * @author         ${user}
 * @version        V1.0 
 * @Date           ${date} ${time}
 */
方法
/**
 * @Title:        ${enclosing_method}
 * @Description:  ${todo}(这里用一句话描述这个方法的作用)
 * @param:        ${tags}   
 * @return:       ${return_type}   
 * @throws
 * @author        ${user}
 * @Date          ${date} ${time}
 */

输入设置模板：

/**     
* ${file_name} Create on ${date}    
*     
* Copyright (c) ${date} by taotaosoft     
*     
* @author <a href="xiuzhong.li@gmail.com">Jerryli</a>    
* @version 1.0
*    
*/

注意择自动添加注释

养成一个规范的习惯是最好的。


菜单
windows-->preference
Java-->Code Style-->Code Templates
code-->new Java files

中点编辑

${filecomment}
${package_declaration}
/**
* @author 作者姓名  E-mail: email地址
* @version 创建时间：${date} ${time}
* 类说明
*/
${typecomment}
${type_declaration}
 
 
 Eclipse注释规范模版总结
1、  具体操作
（1在eclipse中，打开Window->Preference->Java->Code Style->Code Template
（2然后展开Comments节点就是所需设置注释的元素，参照2注释规范对应设置即可
2、  注释规范
（1文件(Files)注释标签
/**
 * FileName:     ${file_name}
 * @Description: ${todo}(用一句话描述该文件做什么)
* All rights Reserved, Designed By ZTE-ITS
 * Copyright:    Copyright(C) 2010-2011
 * Company       ZTE-ITS WuXi LTD.
 * @author:    名字
 * @version    V1.0 
 * Createdate:         ${date} ${time}
 *
 * Modification  History:
 * Date         Author        Version        Discription
 * -----------------------------------------------------------------------------------
 * ${date}       wu.zh          1.0             1.0
 * Why & What is modified: <修改原因描述>
 */
 
（2类型(Types)注释标签（类的注释：
 
/**
 * @ClassName:     ${type_name}
 * @Description:${todo}(这里用一句话描述这个类的作用)
 * @author:    Android_Robot
 * @date:        ${date} ${time}
 *
 * ${tags}
 */
 
（3字段(Fields)注释标签：
 
/**  
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)   
 */  
 
 
（4构造函数标签：
 
/**
 * @Title:        ${enclosing_type}
 * @Description:    ${todo}(这里用一句话描述这个方法的作用)
 * @param:    ${tags}
 * @throws
 */
 
（5方法(Methods)标签：
 
/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(这里用一句话描述这个方法的作用)
 * @param: ${tags}   
 * @return: ${return_type}   
 * @throws
 */
 
（6覆盖方法(Overriding Methods)标签:
 
/**
 * <p>Title: ${enclosing_method}</p>
 * <p>Description: </p>
 * ${tags}
 * ${see_to_overridden}
 */
 
（7代表方法(Delegate Methods)标签：
 
/**
 * ${tags}
 * ${see_to_target}
 */
 
（8getter方法标签：
 
/**
 * @Title:        ${enclosing_method} <BR>
 * @Description: please write your description <BR>
 * @return:     ${field_type} <BR>
 */
 
（9setter方法标签：
 
/** 
 * @Title:  ${enclosing_method} <BR> 
 * @Description: please write your description <BR> 
 * @return: ${field_type} <BR> 
 */ 







可自行导入XML配置文档：
1.准备模板文件codetemplates.xml(将下面的内容复制到你的xml文件中即可使用):

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="false" 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">/**   
 *   
 */   
</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">/**
 ***************************************************************
 * &lt;p&gt;
 * @CLASS                :    ${type_name}
 * @DESCRIPTION    :    
 * @AUTHOR                :    formice
 * @VERSION            :    v1.0
 * @DATE                    :    ${date} ${time}            
 * &lt;/p&gt;
 *
 * &lt;p&gt;
 * @MODIFY    LOG    :        
 * @AUTHOR                :    formice
 * @VERSION            :    v2.0
 * @MODIFY DATE    :    
 * &lt;/p&gt;    
 ****************************************************************
 */</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">/**   
 * create a instance  ${enclosing_type}.   
 * ${tags}   
 */</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  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">/**   
 * @FILE                    :    ${file_name}   
 * @PACKAGE        :    ${package_name}
 * @COPYRIGHT    :    copyright(c) ${year},Rights Reserved
 * @COMPANY        :    
 * @DESCIPTION    :    
 * @AUTHOR            :    formice
 * @VERSION        :    v1.0
 * @DATE                :    ${date} ${time}
 */</template><template autoinsert="false" 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="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**   
 * @param ${param}
 */</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">/**&#13;
 * @description    &#13;
 * @author  formice&#13;
 * ${tags}&#13;
 */&#13;
&#13;
</template></templates>



2. 将xml文件导入到MyEclipse中
Window->Preference->Java->Code Style->Code Templates，点击”Import”,导入你的注释模板文件。
3.生成注释
在创建新类的时候中 ，新创建的类就会自动加上我们定制的注释格式。也可以在以后写代码的时候使用自动添加注释功能， 生成我们定制的注释格式。
注意:该注释模板文件在不同的电脑上模板的格式(比如缩进)可能有稍微的变动，选中Comments下的某一项，点击上面图片的 ，调整下就可以了

\"\"/
###############################################################################################
/**

 * FileName:     ${file_name}

 * @Description: ${todo}(用一句话描述该文件做什么)

* All rights Reserved, Designed By ZTE-ITS

 * Copyright:    Copyright(C) 2010-2011

 * Company       JNSLKJ Song Bin.

 * @author:    SongBin

 * @version    V1.0

 * Createdate:         ${date} ${time}

 *

 * Modification  History:

 * Date         Author        Version        Discription

 * -----------------------------------------------------------------------------------

 * ${date}       SongBin          1.0             1.0

 * Why & What is modified: <修改原因描述>

 */
###############################################################################################
/**
 * @ClassName: ${type_name}
 * @Description: (这里用一句话描述这个类的作用)
 * @author: SongBin
 * @date: ${date} ${time}
 * ${tags}
 */
###############################################################################################
/**
 *
 */
###############################################################################################
/**
 * ${tags}
 */
###############################################################################################
/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(这里用一句话描述这个类的作用)
 * ${tags}
 * @return: ${return_type}
 * @author: SONGBIN
 * @date: ${date} ${time}  
 */
###############################################################################################
/* (non-Javadoc)
 * ${see_to_overridden}
 */
###############################################################################################
/**
 * ${tags}
 * ${see_to_target}
 */
###############################################################################################
/**
 * @return the ${bare_field_name}
 */
###############################################################################################
/**
 * @return the ${bare_field_name}
 */

更多内容请访问：IT源点

注意：本文归作者所有，未经作者允许，不得转载

#eclipse作者注释
阅读全部
相关文章推荐
  • 该目录下还没有内容!
  • 1

全部评论: 0 条

    我有话说: