Java基础——注释

一.注释

1.定义：

• 注释就是使用文字对程序的说明，注释是写给程序员看的，编译器会忽略注释的内容。

2.作用：

• 使用文字对程序说明，提高程序的可读性，使程序的条理更加清晰。

• 通常在程序开头加入作者、时间、版本、要实现的功能等内容注释，方便后来的维护以及程序员的交流。

• 调试程序。

3.类别：

• 单行注释                                         //注释的内容

• 多行注释                                         /*注释的内容*/

• 文档注释                                         /**注释的内容*/

4.注释要注意的细节：

• 单行注释可以嵌套单行使用；多行注释是不能嵌套多行注释使用的。

• 三种注释可以出现在程序的任何地方，但是不推荐找任意位置。

• 一般单行注释是位于代码的右侧，多行注释与文档注释一般是写在类或者方法的上面的。

• 注意：文档注释只能出现在类、属性、方法的上面。

5.文档注释：

• 文档注释用/**   */表示，是Java特有的注释，其中注释内容可以JDK提供的工具javadoc所解析，生成一套以网页（html）文件形式体现的该程序的说明文档。

• 文档注释可以用来编写软件说明书。

• 文档注释只能抽取public属性或者方法内容。

• javadoc的使用格式：javadoc -d 指定存储文档的路径 [-version] [-author] 目标文件（即java源文件）

• 注意：-d后面必须跟存放文档的路径。

• 如果忘记了javadoc工具的使用方法，可以直接在控制台输入javadoc则会出现javadoc的一些方法，所以没必要记。

• 如果一个类需要使用javadoc工具生成一个软件的开发者文档，那么该类必须使用public修饰。

6.多行注释与文档注释的联系与区别：

• 文档注释也是一个多行注释。

• 多行注释的内容不能用于生成一个开发者文档，而文档注释 的内容可以生成一个开发者文档。