第二章 java基础(单行和多行注释)

—— 本文参照 Learn Java for Android Development (第三版)

** 注释**
源码必须是可文档化的，这样也是为了方便代码的阅读。不管是我们平时编写代码的时候或者是修改已经编写完成的代码都需要添加相应的注释。如果修改的内容影响了程序原有的逻辑那么就需要及时更新注释文档，要保证代码跟文档是一致的。
java语言使用注释的方式来完成文档的编写。编译源码的过程注释是不会被编译的，更不会生成注释对应的字节码。java支持的注释方式包括：单行注释、多行注释以及javadoc。
** 单行注释 **
单行注释指的是最多只占用一行的注释方式，这种注释方式通常是以//这符号打头，直到出现这个符号的这一行的结尾都表示这一行的注释内容。例如:
System.out.println(Math.sqrt(10 * 10 + 20 * 20)); // Output distance from (0, 0) to (10, 20).
根据注释我们可以知道这里求的是（0,0）到(10,20)这两个坐标之间的直线距离。使用的是标准库函数sqrt()，sqrt()函数的功能是求一个数字的平方根。
**小贴士： **单行注释通常是短小但是又很有意义的。一般不要用来注释意义不大的东西，比如什么了一个整形变量，后面也加一个单行注释，这就没什么必要了。

** 多行注释 **
多行注释通常会占用一行或者多行。多行注释以这个符号，这对符号中间的就是注释内容，都会被编译器忽略。例如：

System.out.println(year % 400 == 0 || (year % 4 == 0 && year % 100 != 0));
这个例子假定了一个任意的四位数year，然后定义了一个复杂的表达式来判断year是不是闰年。并将判断结果打印出来。注释解释了这个复杂的判断条件。
多行注释里面界定符号不能写错了，一定是，不能是*/。

Page 33