JavaDoc

那些地方需要写注释

基本注释：

• 类和接口

• 构造方法

• 普通方法（除了get和set方法）

• 全局变量

• 字段、属性

特殊注释：

• 典型算法

• 在代码不明晰处

• 在代码修改处加上修改标识注释

• 在循环和逻辑分支组成的代码中注释

• 为他人提供的接口必须详细注释

注释类型

javadoc故名思意，更多的是针对文档的注释。

• 单行注释：//........

• 块注释：/*.........*/

• 文档注释：/**.........*/

javadoc标记

例子

1. 类和接口的注释

   /**
    * AC ServiceImpl 层
    *
    * @author liuyulin10
    * @version v1.3
    * @see com.liuyulin10.hikinter.service.ACService
    */

2. 方法

   /**
    * okhttp实现发送post请求
    *
    * @param req 请求体json
    * @param url 请求url
    * @return 返回请求结果
    * @exception SocketTimeoutException 超时异常
    * @exception IOException IO异常
    * @throws MyException 自定义异常
    */

3. 字段/变量

   /** 设备序列号 */
   @ApiModelProperty(name = "设备序列号",notes = "")
   private String deviceSerial ;