Android Studio添加文件注释头模板

Self Settings:

as中class文件头注释：

File -> Settings -> Editor -> File and Code Templates -> 右侧File标签 -> Class,

模板填入如下内容：

File -> Settings -> Editor -> File and Code Templates -> 右侧File标签 -> Class,

模板填入如下内容：

/** 
* Copyright (C), 2015-${YEAR}, XXX有限公司
* FileName: ${NAME}
* Author: ${USER}
* Date: ${DATE} ${TIME}
* Description: ${DESCRIPTION}
* History:
* <author> <time> <version> <desc>
* 作者姓名 修改时间 版本号 描述
*/
#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#if (${IMPORT_BLOCK} != "")${IMPORT_BLOCK}
#end
/**16 * @ClassName: ${NAME}
* @Description: java类作用描述
* @Author: ${USER}
* @Date: ${DATE} ${TIME}
*/
 #parse("File Header.java")
 #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 {
}

一、类注释

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

二、方法注释

/**
* @method $methodName$
* @description 描述一下方法的作用
* @date: $date$ $time$
* @author: xxxxx
* @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} 

*/