myeclipse中java文件頭註釋格式設置

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="[email protected]">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> 

 */ 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章