一、註釋
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 下可導入導出註釋模板。