一、当行注释

当行注释//,用就完事了很简单~

二、多行注释

多行注释/**/,用就完事了很简单~

三、文档注释

常用的注释方式

3.1、在注释中使用@link``@see链接代码

在写代码的注释时,有时需要把内容相互关联起来,方便在查看的时候,可以直接指向其他的类、属性、方法。
比如@Deprecated标记的类,需要指向推荐使用的新类时,该注解就很有用了。说白了,他就是可以链接指向代码,让我们的注释更清晰易懂。

  • @see注解需要顶着行首写,不然就失效了。
  • {@link}可以放在任何地方,两者实际效果一样。 ```java /**
    • 将 {@link Calendar}月份相关值转换为Month枚举对象
    • @see Calendar#JANUARY
    • @see Calendar#FEBRUARY
    • @see Calendar#MARCH
    • @see Calendar#APRIL
    • @see Calendar#MAY
    • @see Calendar#JUNE
    • @see Calendar#JULY
    • @see Calendar#AUGUST
    • @see Calendar#SEPTEMBER
    • @see Calendar#OCTOBER
    • @see Calendar#NOVEMBER
    • @see Calendar#DECEMBER
    • @see Calendar#UNDECIMBER
    • @param calendarMonthIntValue Calendar中关于Month的int值
    • @return {@link Month} */ public static Month of(int calendarMonthIntValue) { … }

```

3.2、doing