3. 文档注释
使用/**开始，已*/结束
中间的每一行都是已*开头
如：
/**
*这是一个完整的文档注释
*@author 封过不留痕
*@version 1.0
*
*/

要点一： 文档注释一般使用在类的上面，对类进行说明
要点二： 在业务方法上面使用文档注释，对方法进行详细说明
要点三： 文档注释可以使用java doc生成html格式的文档
要点四： 文档注释不能嵌套
要点五： 一份完整的文档注释一般需要包含说明文字、作者、版本号
要点六： 使用javadoc命令生成文档 格式： javadoc -d 文件夹名 -author -version java源文件
例如：
 javadoc -d hello -author -version Hello.java
意思是在当前目录下生成一个hello的文件夹）（如果有hello文件夹则无需生成），并将生成的其他文件放入到hello文件夹中
步骤：
1. 开始菜单 输入CMD 回车  进入命令行窗口
2.cd JavaStudy 回车  进入Hello.java源文件目录下
3. javadoc -d hello -author -version Hello.java 回车即可生成文档，按小键盘2键听到如下内容

正在加载源文件Hello.java...
正在构造 Javadoc 信息...
正在创建目标目录: "hello\"
标准 Doclet 版本 11.0.3
正在构建所有程序包和类的树...
正在生成hello\Hello.html...
Hello.java:12: 警告: args没有 @param
        public static void main(String[] args) {
正在生成hello\package-summary.html...
正在生成hello\package-tree.html...
正在生成hello\constant-values.html...
正在构建所有程序包和类的索引...
正在生成hello\overview-tree.html...
正在生成hello\index-all.html...
正在构建所有类的索引...
正在生成hello\allclasses-index.html...
正在生成hello\allpackages-index.html...
正在生成hello\deprecated-list.html...
正在构建所有类的索引...
正在生成hello\allclasses.html...
正在生成hello\allclasses.html...
正在生成hello\index.html...
正在生成hello\help-doc.html...
1 个警告

PS： 这里的警告，无需理会，以后会进行讨论

PS： 文档注释在eclipse里面会标记为蓝色

-------分隔线 以下是Hello.java的注释版本 ------

/**
*这是我们编写的第一个JAVA程序
*@author 封过不留痕
*@version 1.0
*
*/
public class Hello{
 /*
 *main方法是程序的入口
 */
 public static void main(String[] args) {
  //下面的代码是输出到平武的语句
  System.out.println("Hello World");

 }

}
}

        欢迎喜欢编程的朋友回帖讨论，您的回帖是对我的最大支持！您的支持是我创作的源泉！