JAVA开发之 11-JAVA语言基础（注释概述及其分类）

注释是一个程序员必须要具有的良好编程习惯；
初学者编程写程序可以养成习惯：先写注释，再写代码；
将自己的思想通过注释先整理出来，再用代码去体现；
因为代码仅仅是思想的一种体现形式而已。

对于Java注释我们主要了解三种：
1）单行注释： // 注释文字 表示注释一行 （可以嵌套）
2）多行注释 : /* 注释文字 */ 表示注释若干行（不能嵌套）
3）文档注释: /*注释文字 / 表示文档注释（不能嵌套）

当在代码中填写好注释后，就可以使用JavaDoc工具提取程序中文档注释生成API文档，Javadoc 工具能从 java 源文件中读取第三种注释，并能识别注释中用@标识的一些特殊变量，制作成 Html 格式的类说明文档。javadoc 不但能对一个 java 源文件生成注释文档，而且能对目录和包生成交叉链接的 html 格式的类说明文档，十分方便。
常用的Javadoc标记如下：
@author 指定Java程序的作者
@version 指定源文件版本
@parameter 参数名及其意义
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告（标识一个方法已经不推荐使用了）
@see “参见”，指定交叉参考的内容
@since 表示从那个版本起开始有了这个函数
@note 表示注解，暴露给源码阅读者的文档
{@value} 当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。
{@link包.类#成员} 链接到某个特定的成员对应的文档中。

说明：
只有“/*…/”* 的注释语句中的内容才能被javadoc工具支持，所以javadoc的标记只能放在“/***…*/”注释中。