注释的规范性是不言而喻的 规范的注释还可以导出javadoc来生成接口文档 所以写好注释从头做起 下面跟着我们的镜头 一起来看吧!

一.文件注释

创建文件后 编译器会在类名前面生成固定的注释 来丰富代码的可读性 在阿里巴巴Java开发手册里 也明确写到所有的类都必须添加创建者和创建日期。

/**
 * description: xxxxx <br>
 * date: ${DATE} ${TIME} <br>
 * author: objcat <br>
 * version: 1.0 <br>
 */

二.方法注释

写方法的时候也要带上相应的注释 这样可以增加方法的可读性 下面我们就来添加一个自定义注释模板

1.创建一个group名字随便起

2.选中group并新建一个模板

添加快捷键与注释

Abbreviation 关键字(使用的时候是 关键字 + tab)
Description 模板说明

写入注释模板

/**
 * description: xxxx <br>
 * version: 1.0 <br>
 * date: $date$ $time$ <br>
 * author: objcat <br>
 * @param $params$ 
 * @return $returns$
 */ 

关联变量 按照图中的方法关联 或者自定义

这里说一下为什么要关联变量 你应该可以发现在模板中有
$date$ $time$ $params$ $returns$ 这些用$符号包括的代码 这些都是自定义变量 而我想在写注释的时候 实时获取这些 比如时间 日期 参数名 返回值类型 所以需要关联编译器的变量自动填入

到了这一步 设置都结束了

使用方法是在代码中 方法的上一行或方法内部 输入// 然后按 tab 键就会自动出现注释了

//是可以通过Abbreviation自定义的

好的我们来看一看效果吧

我们来生成一个javadoc看看效果
Tools -> Generate JavaDoc

finally enjoy it

by objcat 2018.11.8