为提高代码的可读性以及后期的可维护性,为我们的代码加上规范化的注释是很有必要,不仅有利于提高自己的专业素养,也能方便他人
1、设置的入口,我我们可以在下图所示的地方个性化我们自己的代码风格
2、文件(Files)注释标签
/* * @Title: ${file_name} * @Copyright: XXX Co., Ltd. Copyright YYYY-YYYY, All rights reserved * @Description: ${todo}<请描述此文件是做什么的> * @author: MeiYi * @data: ${date} ${time} * @version: V1.0 */
3、类(Types)注释标签
/** * ${todo}<请描述这个类是干什么的> * @author MeiYi * @data: ${date} ${time} * @version: V1.0 */
4、方法(Methods)注释标签
/** * ${todo}<请描述这个方法是干什么的> * ${tags} * @throw * @return ${return_type} */
5、其他的大家可以自己试试看,后面我会吧模板共享一份出来,有兴趣的可以自己改着玩玩
6、注意事项
6.1、配置注释模板(如上图)的界面中,记得把""选项卡勾上,这样在新建java类时,会自动添加文 件注释和类注释。
6.2、当你在类中自己写了一个方法,你需要手工的为这个方法添加注释
7、模板下载地址:http://pan.baidu.com/share/link?shareid=2460527960&uk=1025688061