eclipse中代碼的註釋模板

編輯註釋模板的方法:Window->Preference->Java->Code Style->Code Template
然後展開Comments節點就是所有需設置註釋的元素啦。
在這裏插入圖片描述在這裏插入圖片描述
1、文件(Files)註釋標籤:

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

2、類型(Types)註釋標籤(類的註釋):

/**   
 * @ClassName:  ${type_name}   
 * @Description:${todo}(這裏用一句話描述這個類的作用)   
 * @author: xiaozhi  
 * @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}
 * @date:   ${date} ${time}
 * @throws
 */

/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(這裏用一句話描述這個方法的作用)
 * @author: JiaHongzhi
 * @since: ${date} ${time}
 * ${tags}
 * @return: ${return_type}
 * @date:   ${date} ${time}
 */

6、覆蓋方法(Overriding Methods)標籤:

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

7、getter方法標籤:

/**  
 * @Title:  ${enclosing_method} <BR>  
 * @Description: please write your description <BR>  
 * @return: ${field_type} <BR>  
 */  

8、setter方法標籤:

/**  
 * @Title:  ${enclosing_method} <BR>  
 * @Description: please write your description <BR>  
 * @return: ${field_type} <BR>  
 */ 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章