eclipse註釋規範

文件註釋標籤：

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

類型註釋標籤（類的註釋）：

/**
 * @ClassName: ${type_name}
 * @Description: ${todo}(這裏用一句話描述這個類的作用)
 * @author A18ccms a18ccms_gmail_com
 * @date ${date} ${time}
 * 
 * ${tags}
 */
字段註釋標籤：

/**
 * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
 */
構造函數標籤：

/**
 * <p>Title: </p>
 * <p>Description: </p>
 * ${tags}
 */
方法標籤：

/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(這裏用一句話描述這個方法的作用)
 * @param ${tags}    設定文件
 * @return ${return_type}    返回類型
 * @throws
 */
覆蓋方法標籤：

/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法標籤：

/**
* ${tags}
* ${see_to_target}
*/
getter方法標籤：

/**
* @return ${bare_field_name}
*/
setter方法標籤：

/**
* @param ${param} 要設置的 ${bare_field_name}
*/
新建Java文件：

${filecomment}
${package_declaration}
/**   
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}(添加描述)
 * @author A18ccms A18ccms_gmail_com
 * @date ${date} ${time}    
 * @version V1.0   
 */  
${typecomment}
${type_declaration}

 

   使用時鼠標放置在需要添加註釋的方法內部的任意位置。點擊菜單欄中【源代碼】下的【添加Javadoc註釋】，或者使用快捷鍵Alt Shift J，則eclipse自動在該方法前面添加註釋，例如public static void main(String[]args)生成如下注釋：

 

當然添加完之後還需要手動添加其中的各項內容，如方法的功能和參數的含義等。