Java注释及文档注释

Java注释有三种方式

代码是写给人看的，写注释是为了能让人快速看懂代码，方便程序员间的交流。代码要有规范，要有良好的风格，要有很好的可读性，合理的注释是提高代码可读性的方法之一。

单行注释 //

以 // 开头, // 后面的内容都会被认为是注释。

示例：

//年龄
//性别
//爱好

多行注释 /**/

以 /* 开头,以 */ 结束, /* 和 */ 之间的的内容都会被认为是注释。
多行注释用于说明比较复杂的内容，如复杂的逻辑或者算法。

示例：

/*
 * 年龄
 * 性别
 * 爱好
 */

文档注释 /***/

以 /** 开头,以*/结束, /** 和 */ 之间的的内容都会被认为是注释。

示例：

/**
 * 学生类
 * @author Jason
 * @version 2.0
 */

文档注释可以提取出来，生成像官方API帮助文档风格一样的文档。
使用JDK提供的javadoc命令，可以自动生成一份HTML格式的文档，风格和官方API帮助文档一样。
使用javadoc命令提取文档：

javadoc -d doc -encoding UTF-8 -charset UTF-8 xxx.java

这条命令的意思就是把xxx.java中的文档注释提取出来，生成的帮助文档放在doc文件夹下，其编码格式为UTF-8。