Android Studio添加文件注釋頭模板集合

 

Android Studio中設置方式

File -> Settings -> Editor -> File and Code Templates -> 右側File標簽 -> Class, 模板填入如下內容：

一、類注釋

/** 
* 
* @ProjectName: ${PROJECT_NAME}
* @Package: ${PACKAGE_NAME}
* @ClassName: ${NAME}
* @Description: java類作用描述 
* @Author: 唐朝
* @CreateDate: ${DATE} ${TIME}
* @UpdateUser: 更新者
* @UpdateDate: ${DATE} ${TIME}
* @UpdateRemark: 更新說明
* @Version: 1.0
*/

 

二、方法注釋

/**
* @method $methodName$
* @description 描述一下方法的作用
* @date: $date$ $time$
* @author: 唐朝
* @param $param$
* @return $return$
*/
 

 

三、文件(Files)注釋標簽：

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

 

四、類型(Types)注釋標簽（類的注釋）：

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

 

 

關於我

私人博客

微信公眾號:infree6 或者直接掃碼