文章出處

一、注釋                                  

  1. 注釋類型

     [a]. 單行注釋

// 單行注釋
String type = "單行注釋";

     [b]. 多行注釋

/* 
 * 多行注釋
 */
String type = "多行注釋";

     [c]. 文檔注釋

/**
 * 文檔注釋
 */
public class Dummy{}

  2. 快捷鍵

     [a]. 添加/取消單行注釋: Ctrl+/ 

     [b]. 添加類的文檔注釋: Ctrl+Shift+j 

 

二、注釋模板                                

  作用:定義文件、類和方法等默認的注釋格式,減少手工輸入的工作量。

  1. 設置注釋模板的入口:點擊 Window->Preference->Java->Code Style->Code Template ,然后展開 Comments節點 。

  2. Comments節點 下的元素介紹:

     File節點(文件注釋標簽)

/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句話描述該文件做什么) 
* @author fsjohnhuang
* @date ${date} ${time} 
* @version V1.0   
*/

     Types節點(類注釋標簽)

/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(這里用一句話描述這個類的作用) 
* @author fsjohnhuang
* @date ${date} ${time} 
* 
* ${tags} 
*/

      Fields節點(字段注釋標簽)

/** 
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什么) 
*/ 

     Constructor節點(構造函數注釋標簽)

/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/

     Method節點(方法注釋標簽)

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(這里用一句話描述這個方法的作用) 
* @param ${tags}  參數說明 
* @return ${return_type}    返回類型 
* @throws 
*/

     Overriding Methods節點(覆蓋方法注釋標簽)

/*
* Title: ${enclosing_method}
*Description: 
* ${tags} 
* ${see_to_overridden} 
*/

    Delegate Methods節點(代理方法注釋標簽)

/** 
* ${tags} 
* ${see_to_target} 
*/ 

    getter節點(getter方法注釋標簽)

/** 
* @return ${bare_field_name} 
*/

    setter節點(setter方法注釋標簽)

/** 
* @param ${param} 要設置的 ${bare_field_name} 
*/

  3. 導入、導出注釋模板

    在 Window->Preference->Java->Code Style->Code Template 下可導入導出注釋模板。

 尊重原創,轉載請注明來自:http://www.cnblogs.com/fsjohnhuang/p/3988883.html  ^_^肥仔John


文章列表




Avast logo

Avast 防毒軟體已檢查此封電子郵件的病毒。
www.avast.com


arrow
arrow
    全站熱搜
    創作者介紹
    創作者 大師兄 的頭像
    大師兄

    IT工程師數位筆記本

    大師兄 發表在 痞客邦 留言(0) 人氣()