Android Studio添加文件註釋頭模板

Self Settings:

as中class文件頭註釋：

 

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

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

 1 /**
 2 * Copyright (C), 2015-${YEAR}, XXX有限公司
 3 * FileName: ${NAME}
 4 * Author: ${USER}
 5 * Date: ${DATE} ${TIME}
 6 * Description: ${DESCRIPTION}
 7 * History:
 8 * <author> <time> <version> <desc>
 9 * 做者姓名 修改時間 版本號 描述
10 */
11 #if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
12 
13 #if (${IMPORT_BLOCK} != "")${IMPORT_BLOCK}
14 #end
15 /**
16 * @ClassName: ${NAME}
17 * @Description: java類做用描述 
18 * @Author: ${USER}
19 * @Date: ${DATE} ${TIME}
20 */ 
21 #parse("File Header.java")
22 #if (${VISIBILITY} == "PUBLIC")public #end #if (${ABSTRACT} == "TRUE")abstract #end #if (${FINAL} == "TRUE")final #end class ${NAME} #if (${SUPERCLASS} != "")extends ${SUPERCLASS} #end #if (${INTERFACES} != "")implements ${INTERFACES} #end {
23 }

--說明：如上模板設置辦法，也能夠用於方法、接口、以及json等文件

 

https://blog.csdn.net/u010503822/article/details/78545095###;

設置文件頭 

類註釋

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

 2.配置方法經過短名進行生成註釋

cmt這個用於快捷生成，相似myeclipse的main回車的快速生成main方法。

/** * * @ProjectName: $PROJECT_NAME$ * @Package: $PACKAGE_NAME$ * @ClassName: $NAME$ * @Description: java類做用描述 * @Author: 唐朝 * @CreateDate: $DATE$ $TIME$ * @UpdateUser: 更新者 * @UpdateDate: $DATE$ $TIME$ * @UpdateRemark: 更新內容 * @Version: 1.0 */

• mcmt

mcmt的做用相似cmt，須要注意這裏在java方法內部輸入「mcmt」回車，出現生成的註釋。

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

 

groovyScript腳本，上面的params配置

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters())

 

---

 

1、類註釋

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

2、方法註釋

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

+++++++++++

Eclipse Java註釋模板設置詳解
設置註釋模板的入口： Window->Preference->Java->Code Style->Code Template 而後展開Comments節點就是全部需設置註釋的元素啦

文件(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} */