Java的注释
- 单行注释
- 多行注释
- 文档注释
单行注释：在需要注释的内容前面加上双斜线(//)
多行注释：将需要注释的内容用 /* */ 包含起来
文档注释：/** */ 文档注释用于生成API文档(使用javadoc来生成)，API文档主要用来说明类、成员变量、方法的功能。所以，javadoc工具只处理在类、接口、内部类、成员变量、方法、构造器前的注释。而且，默认用private修饰的方法或者成员变量等不生成注释文档，除非在使用javadoc工具的时候加上-private参数。
javadoc工具的基本用法：
javadoc 一堆参数 java源文件（或者包）
可带的参数有：
-d <directory> 指定将生成的API文档放在那个目录下
-windowtitle <text> 设置API文档的浏览器窗口标题
-author 在文档中显示author(需要注释中有指明author)
-version 在文档中显示version
-charset 指定API文档的编码，如 -charest utf-8
其他更多的参数 使用javadoc --help (linux系统)查看
在写文档注释的时候可以用的一些标记：
@author 作者
@version 版本
@param 方法的参数说明
@return 方法的返回值
@see 参见，指定参考内容
@exception 抛出的异常的类型
@throws 和exception一样
可以在每个包中创建一个package.html对包进行描述，然后通过 javadoc 一堆参数 包 直接将包中的所有类的注释提取到API文档中
