Java 注释

---

---

  用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性（可读性）。
  注释是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来，再用代码去体现。
  被注释的文字，不会被 JVM（java 虚拟机）解释执行。
  多行注释里面不允许有多行注释嵌套。

---

一、单行注释 //

  基本格式：

//需要注释的文字

二、多行注释 /*

  基本格式：

/*  需要被注释的第一行
	需要被注释的第二行
	...
	需要被注释的第N行 */

  在下面的实例中，演示了使用单行注释和多行注释的过程：

//演示注释使用
public class comment{
	//编写一个main方法
	public static void main(String[] args) {
		//这是单行注释
		/*这是多行注释
		下面代码
		是完成两数相加
		这些注释不会被执行*/
		int n1 = 1;
		int n2 = 9;
		int sum = n1+n2;
		System.out.println("结果等于" + sum);
	}
}

  结果如下图：

三、文档注释

  文档注释负责描述类、接口、方法、构造器、成员属性。可以被JDK提供的工具 javadoc 所解析，自动生成一套以网页文件形式体现该程序说明文档的注释。

  下面介绍写在类上的文档标注，示例如下：

/**
 * @author 江南赴艽野
 * @version 1.0
 */
public class comment{
	public static void main(String args){

	}
}

  前四行就是文档注释的内容，必须以 /** 格式开头，其中@开头的内容被称为Javadoc文档标记，是JDK定义好，不能随便使用。
javadoc 工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

  确定好文档注释中的内容后，使用命令：

javadoc -d 生成的路径和文件名 -标签 文件名.java

示例如下图：

  因为这里我举例使用了两个标签，所以命令行中写入“ -author -version”。
  这时打开e盘中的temp文件夹，可以看到生成很多相关文件：

  以网页形式打开文件夹中的index.html

  就可以查看编写的文档注释的相关内容了