注释

注释

定义：用于解释说明程序的文字

• 单行注释 格式： // 注释文字

• 多行注释 格式： /* 注释文字 */

• 文档注释 格式：/** 注释文字 */

阿里巴巴java开发手册--注释规范

【强制】类、类属性、类方法的注释必须使用 javadoc 规范，使用/*内容/格式，不得使用 //xxx 方式。

【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

【强制】所有的抽象方法（包括接口中的方法）必须要用 javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

【强制】所有的类都必须添加创建者信息。

【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改

总结：

1. 每当创建一个类的时候都要在顶部标注好作者，方便出了问题别人可以联系你

2. 每当创建类的时候要 使用文档注释进行标注这个类是什么，使用文档注释标注类里面每一个字段是什么意义

/**
 * Description：
 *
 * @author 高建强
 * @company: Terminus
 * @since : 2021/12/3 10:47 上午
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class ErdaCostParam {
​
    /**
     * 开始时间
     */
    private Long start;
​
    /**
     * 结束时间
     */
    private Long end;
}

3. 对于某个方法中就不需要使用文档注释，一般使用 // 单行文本注释，字数太多就用多行文本注释（注：一般不使用）。

4. 修改代码的时候要及时的修改相应的注释，这样的我们的注释这样注释才有意义。

注释的意义

• 方便别人读懂我们的代码

• 方便自己修bug的时候不会忘记当时逻辑怎么写的

• 注释也是代码的一部分