java注释头模板_Android Studio添加文件注释头模板？

设置文件头

类注释

/**

*

*@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}(用一句话描述这个变量表示什么)

*/

构造函数标签：

/**

*

Title:

*

Description:

* ${tags}

*/

方法(Constructor & Methods)标签：

/**

* @Title: ${enclosing_method}

* @Description: ${todo}(这里用一句话描述这个方法的作用)

* @param ${tags} 设定文件

* @return ${return_type} 返回类型

* @throws

*/

覆盖方法(Overriding Methods)标签：

/* (非 Javadoc)

*

Title: ${enclosing_method}

*

Description:

* ${tags}

* ${see_to_overridden}

*/

代表方法(Delegate Methods)标签：

/**

* ${tags}

* ${see_to_target}

*/

getter方法标签：

/**

* @return ${bare_field_name}

*/

setter方法标签：

/**

* @param ${param} 要设置的 ${bare_field_name}

*/