Java注释

Java注释

与大多数程序设计语言一样，Java中的注释也不会出现在可执行程序中，不必担心代码会膨胀。
有三种注释方式：
单行注释：//单行注释内容
多行注释：：多行注释不能嵌套
文档注释：:可自动生成文档

文档注释上面有两个星号，生成的文档默认以Html形式保存，可以生成说明文档。

JavaDoc命令

从程序源代码中抽取文档注释形成一个和源代码配套的API帮助文档，在编写程序时以文档标签做注释，在编写完成后，通过Javadoc可以自动生成程序的开发文档。

javadoc 选项 java源文件|包

选项：

1. d(directory):该选项指定一个路径，用于将生成的API文档放到指定目录下。
2. windowtitle(text):该选项指定一个字符串，用于设置API文档的浏览器窗口标题。
3. doctitle(html-code):该选项指定一个HTML格式的文本，用于指定概述页面的标题。
   注意：只有对处于多个包下的源文件来生成API文档时，才有概述页面。
4. header(html-code):该选项指定一个HTML格式的文本，包含每个页面的页眉。
5. 除此之外，javadoc命令还包含了大量其他选项，我们可以通过在命令行窗口执行
   javadoc-help命令来查看javadoc命令的所有选项。
   javadoc -d D:Workspacesapi_doc -windowtitle 测试API -doctitle 学习javadoc -header *Test.java

文档注释内容：

@author：指定Java程序的作者
@version：指定源文件的版本
@depreated：不推荐使用的方法
@param：方法的参数说明信息
@return：方法的返回值说明信息
@see：“参见”，用于指定交叉参考的内容
@exception：抛出异常的类型
@throws：抛出的异常，和@exception同义

---

API文档类似于产品的使用说明书，通常只需要介绍那些暴露的、供用户使用的部分，在java类中就是以public或protected修饰的内容，因此javadoc默认只处理public或protected修饰的内容。如果开发者确实希望可以提取private修饰的内容，则可以在命令行使用javadoc工具时增加-private选项。还有，javadoc工具只处理文档源文件在类、接口、方法、成员变量、构造器和内部类之前的文档注释，忽略其他地方的文档注释。