1. 单行注释

单行注释通常用于解释方法内某单行代码的作用。

public void method() {
    // age 用于表示年龄
    int age = 18;
}
  1. 多行注释

多行注释使用的频率其实并不高,通常用于解释一段代码的作用。

/*
age 用于表示年纪
name 用于表示姓名
*/
int age = 18;
String name = "六哥";

// 感觉下面的还更方便 doge

// age 用于表示年纪
// name 用于表示姓名
int age = 18;
String name = "六哥";
  1. 文档注释

文档注释可用在三个地方,类、字段和方法,用来解释它们是干嘛的。

/**
 * 微信搜索「沉默王二」,回复 Java
 */
public class Demo {
    /**
     * 姓名
     */
    private int age;

    /**
     * main 方法作为程序的入口
     *
     * @param args 参数
     */
    public static void main(String[] args) {

    }
}
  1. javadoc

javadoc 是一个工具,用于生成文档。

javadoc 的使用方法:

javadoc -d docs -encoding UTF-8 -charset UTF-8 -sourcepath src -subpackages com.silence.demo

javadoc 的生成结果:

骗你的辣, 哈哈哈~

菜菜,捞捞~