你好呀，我是沉默王二，一枚颜值与才华俱在的程序员。本篇教程通过我和三妹对话的形式来谈一谈“Java 中的注释”。
教妹学 Java，没见过这么有趣的标题吧？“语不惊人死不休”，没错，标题就是这么酷炫，毕竟面向对象编程。专栏现在定价只要 9.9 元，我在想，CSDN 这是赔本生意啊，定价也太低了，趁早买，买到的同学我只能说你赚到了，后面 CSDN 肯定会涨价。如果你购买了专栏，还可以添加我的个人微信【qing_geee】，有任何学习上的问题都可以随时向我提问，坑位所剩无几，手慢无。另外，我有几个高质量的交流群，我会不定期在群里分享学习资源，福利等等，感兴趣的可以说下我邀请你！
下面就由我来介绍一下故事的背景吧。
我有一个漂亮如花的妹妹（见上图），她叫什么呢？我想聪明的读者都能猜得出：沉默王三，没错，年方三六。父母正考虑让她向我学习，做一名正儿八经的 Java 程序员。我期初是想反抗的，因为程序员这行业容易掉头发。但家命难为啊，与其反抗，不如做点更积极的事情，写点有趣的文章，教妹妹如何更快地掌握 Java 这门编程语言。毕竟程序员还算得上高薪（都是拿命换的啊）。
“二哥，今天我们要学习的内容是‘Java 注释’，对吧？”
“是的，三妹。Java 注释通常用来说明一个变量的用处、一个方法的 API、一个类的作用等等，它不会被编译器和解释器执行，但程序员可以通过注释来更好地理解代码。”
注释有 3 中类型：
1）单行注释
int age = 18; // age 用于表示年龄
单行注释通常用于解释单行代码的作用
2）多行注释
/*
age 用于表示年纪
name 用于表示姓名
*/
int age = 18;
String name = "沉默王二";
多行注释使用的频率其实并不高，通常用于解释一段代码的作用。
3）文档注释
/**
* 这个类用于演示文档注释
*
* @author 沉默王二
*/
public class CommentDemo {
/**
* main 函数为程序的主入口
* @param args
*/
public static void main(String[] args) {
}
}
文档注释可用于类级别，解释这个类的基本作用，以及注意事项；也可以用于方法级别，解释方法的参数，返回类型，以及方法的作用。
当这个类保存后，我们可以执行 javadoc 命令生成 API 文档。
javadoc CommentDemo.java -encoding utf-8
-encoding utf-8 可以保证中文不发生乱码。稍等片刻，javadoc 命令正在执行。
等待文档生成。然后在对应文件夹下可以看到生成的文件。
双击点开 index.html 文件就可以通过浏览器查看我们写的注释文档了。
可以看到我们之前写的文档注释了。有没有很开心？
本篇文章为《教妹学Java》专栏的第二十篇文章，是不是轻松又活泼，学技术再也不枯燥了，对吧？购买专栏的同学都是冲着二哥名声来的，我只能说你很有眼光。
教妹学Java(六)：JDK，JRE和JVM之间有什么区别？
PS：本篇文章中的示例代码已经同步到码云，传送门~
PSS：教程的思维导图已同步到 ProcessOn，传送门~
别瞅了，点赞就对了，你最美你最帅。需要加群进行技术交流的话，就加我的微信（qing_geee）告诉我吧，我会不定期在群里分享学习资源、福利等等，早就是优势，感兴趣的就快来吧！
扫一扫
3万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
