你想快速的自定义实体类或Android四大组件类、方法体、实体类等头部注释模板吗?来一起来简单的试试吧:
1.实现简单的java实体类Bean的自定义头部模板:
/**
* 版权:KING公司 版权所有
*
* @author KING
* 版本:1.0
* 创建日期:2019/6/6
* 描述:---
*/
看看上面的模板,再看看下面的实现步骤:
点击File -> Settings ->Editor ->File and Code Templates,在详细展示窗口点击includes选项卡,找到
FileHeader点击,在编辑窗口输入自定义的注释模板即可。看图:
点击Apply--OK,然后你创建一个实体类试试吧。
/**
* 版权:KING公司 版权所有
*
* @author KING
* 版本:1.0
* 创建日期:2019/6/6
* 描述:---
*/
public class MySgfBean {
}
2.添加Activity添加头部模板:
点击File -> Settings ->Editor ->Live Templates,在编辑窗口输入自定义的注释模板即可。如下图所示:
选择右上角的1.Live Template,然后添加注释,点击Apply---OK ,然后去创建你的activity,你会发现创建好的activity头部什么都没有,别急,在写注释的位置输入你新建的sgftemplate(sgftemplate是自己起的名字,你随便起吧),一般你输入名字的首字母就会有提示的,比如这里输入s就会有提示:
然后你回车就出来了:
import android.os.Bundle;
import com.example.mysgfceshicase.R;
/**
* 版权:KING公司 版权所有
* @author KING
* 版本:1.0
* 创建日期:2019/6/6
* 描述:---
*
*/
public class CeshiActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_ceshi);
}
}
3.添加统一方法的文档模板:
a.File->Setting->Editor->Live Templates
b.点击+,创建一个Template Group
c.填个你要的group名,我的叫sgfgroup
d.选中你刚刚创建的group,创建Live Template
e.填写Abbreviation,我这里填的是cmt,也即你这个注释的快捷方式,你敲cmt加回车,模板就出来了
Template text是注释的模板,具体你模板要怎么写都可以:
f.要设置你这个cmt快捷键在哪里生效,我的选择是在声明的时候生效,也即你在方法名上打cmt加回车就可以了
g.注意:我的Template text有定义了三个变量 desc,date,time,后面两个我要生成日期和时间,所以我们要编辑这两个变量
点击Edit variables,在弹窗里分别为date 和time就是设置对应的方法,date()这个方法会生成日期,time()这个方法会生成时间
然后点击Apply---OK就可以了。
/**
* @author KING
* 创建日期:2019/6/6
* 描述:---
*/
private void initView() {
}
h.设置方法的文档注释自定生成系统时间:
/**
* @Author:
* @Description: (用一句话描述)
* @Time 2019/11/21 11:13
*/
public void Sgf(){
}
在Edit variables点击后的弹框中选择你需要的time、date等,然后在下面箭头的位置选择好相应的方法就可以了。
注意:若自定义注释 Edit variables不可点击状态为灰色,那就是注释模板不对,模板有Android studio和eclipse之分,详情看看下面的博客:
//Eclipse注释模板
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author ${user}
* @date ${date}
* @version V1.0
*/
//androidstudio 注释模板
/**
* @Title: $file_name$
* @Package $package_name$
* @Description: $todo$(用一句话描述)
* @author $user$
* @date $date$
* @version V1.0
*/
https://blog.csdn.net/ezconn/article/details/82712012
去试试吧
4.常用文档注释模板:
a、类注释
/**
*
* @ProjectName: ${PROJECT_NAME}
* @Package: ${PACKAGE_NAME}
* @ClassName: ${NAME}
* @Description: java类作用描述
* @Author: KING
* @CreateDate: ${DATE} ${TIME}
* @UpdateUser: 更新者
* @UpdateDate: ${DATE} ${TIME}
* @UpdateRemark: 更新说明
* @Version: 1.0
*/
b、方法注释
/**
* @method $methodName$
* @description 描述一下方法的作用
* @date: $date$ $time$
* @author: KING
* @param $param$
* @return $return$
*/
c.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}
*/
5.常用的头文件通配符:
${PACKAGE_NAME} 新建文件所在包名
${USER} 用户名
${DATE} 创建文件时当前系统的日期(格式:yyyy/MM/dd)
${TIME} 创建文件时当前系统的时间(格式:hh:mm)
${YEAR} 创建文件时当前系统的年份
${MONTH} 创建文件时当前系统的月份
${MONTH_NAME_SHORT} 当前月份的前三位字符缩写,例如: Jan, Feb, etc
${MONTH_NAME_FULL} 当前月份的字母全写,例如: January, February, etc
${DAY} 当前时间所属月份的天数
${HOUR} 当前的小时数
${MINUTE} 当前的分钟数
${PROJECT_NAME} 当前的项目名
${NAME} 当前的文件名