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())

 


 

一、类注释

/**
*
* @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$
*/


+++++++++++

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}
*/

 

 

posted @ 2018-04-08 22:10  petercao  阅读(26646)  评论(0编辑  收藏