博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Android Studio添加文件注释头模板?
阅读量:6568 次
发布时间:2019-06-24

本文共 3578 字,大约阅读时间需要 11 分钟。

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 * 

--说明:如上模板设置办法,也可以用于方法、接口、以及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}
*/

 

 

你可能感兴趣的文章
php采集 纠正一下
查看>>
phalcon遇到的那些坑
查看>>
Java类的连接与初始化 (及2013阿里初始化笔试题解析)
查看>>
unity优化笔记
查看>>
linux
查看>>
JavaScript改变 HTML 内容
查看>>
IPv6过渡技术
查看>>
内核调度进程的机制
查看>>
python-68:BS4获取多个标签的文本
查看>>
OSPF中stub area配置实例
查看>>
c primer plus 5 读书笔记1
查看>>
YY的GCD
查看>>
AGC029 E: Wandering TKHS
查看>>
iphone-common-codes-ccteam源代码 CCRadix.m
查看>>
百度分页样式
查看>>
变量声明和定义的区别
查看>>
卖了5个月水果之后再看互联网思维
查看>>
boost::asio与ACE的对比
查看>>
国内maven库镜像(阿里云)
查看>>
SNMP AGENT函数介绍
查看>>