設置註釋模板的入口: Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設置註釋的元素啦。現就每一個元素逐一介紹:
文件(Files)註釋標籤:
/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句話描述該文件做什麼) * @author rex * @date ${date} ${time} * @version V1.0 */ |
類型(Types)註釋標籤(類的註釋):
/** * @ClassName: ${type_name} * @Description: ${todo}(這裏用一句話描述這個類的作用) * @author rex * @date ${date} ${time} * * ${tags} */ |
字段(Fields)註釋標籤:
/** * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼) */ |
構造函數標籤:
/** * <p>Title: </p> * <p>Description: </p> * ${tags} */ |
方法(Constructor & Methods)標籤:
/** * @Title: ${enclosing_method} * @Description: ${todo}(這裏用一句話描述這個方法的作用) * @param ${tags} 設定文件 * @return ${return_type} 返回類型 * @throws */ |
覆蓋方法(Overriding Methods)標籤:
/* (非 Javadoc) * <p>Title: ${enclosing_method}</p> * <p>Description: </p> * ${tags} * ${see_to_overridden} */ |
代表方法(Delegate Methods)標籤:
/** * ${tags} * ${see_to_target} */ |
getter方法標籤:
/** * @return ${bare_field_name} */ |
setter方法標籤:
/** * @param ${param} 要設置的 ${bare_field_name} */ |