05 文档注释

文档注释以/**开头以*/结尾， 注释中包含一些说明性的文字及一些JavaDoc标签，例如：

/**
文档注释
@author gh
@version 1.0
这是文档注释的代码
*/
public class HelloWorld{
        public static void main(String[] args){
                System.out.println("HelloWorld!");
        }
        /**
        @param name 姓名
        @param age 年龄
        */
        public void eat(String name,int age){
                System.out.println("Eat!");
        }
}

一般文档注释可以配合jdk提供的工具javadoc.exe来一起使用，通过javadoc.exe可以对文档注释进行解析，生成一套以网页文件形式体现的该程序的说明文档：

当前目录下会生成一个文件夹：

点击打开index.html文件可以看到：

相当于自定义一个类对应的API。