Eclipse 代碼模板配置：豐富註釋與常用代碼片段

註釋模板

路徑：Window → Preferences → Java → Code Style → Code Templates → Comments

文件註釋

/**
 * Project Name: ${project_name}
 * File Name: ${file_name}
 * Package Name: ${package_name}
 * Date: ${date} ${time}
 * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
 */

類註釋

/**
 * ClassName: ${type_name} <br/>
 * Function: ${todo} ADD FUNCTION. <br/>
 * Reason: ${todo} ADD REASON(可選). <br/>
 * date: ${date} ${time} <br/>
 * @author ${user}
 * @version ${enclosing_type}${tags}
 * @since JDK 1.6
 */

方法註釋

/**
 * ${enclosing_method}:(這裡用一句話描述這個方法的作用). <br/>
 * ${todo}(適用條件).<br/>
 * ${todo}(執行流程).<br/>
 * ${todo}(使用方法).<br/>
 * ${todo}(注意事項).<br/>
 * @author ${user}
 * ${tags}
 * @since JDK 1.6
 */

代碼模板

路徑：Code Templates → Code

新建 Java 文件

/**
 * Project Name: ${project_name}
 * File Name: ${file_name}
 * Package Name: ${package_name}
 * Date: ${date} ${time}
 * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
 */
${filecomment}
${package_declaration}
/**
 * ClassName: ${type_name} <br/>
 * Function: ${todo} ADD FUNCTION. <br/>
 * Reason: ${todo} ADD REASON. <br/>
 * Date: ${date} ${time} <br/>
 * @author ${user}
 * @version
 * @since JDK 1.6
 * @see
 */
${typecomment}
${type_declaration}

常用片段

• 方法體：// ${todo} Auto-generated method stub ${body_statement}
• 構造器體：${body_statement} // ${todo} Auto-generated constructor stub
• Getter：return ${field};
• Setter：${field} = ${param};
• Catch 塊：// ${todo} Auto-generated catch block ${exception_var}.printStackTrace();

導出 codetemplates.xml 可在團隊間共享統一風格。