JavaDoc

  • javadoc命令是用来生成自己API文档的

参数信息

  • @author 作者名

  • @version 版本号

  • @since 指明需要最早使用的jdk版本

  • param 参数名

  • return 返回值情况

  • throws 异常抛出情况

程序员规范：阿里巴巴Java开发手册

 1 package com.Xujie.Day06;
 2 
 3 public class Java06_5 {
 4     /**
 5      * @author Xujie
 6      * @version 1.0
 7      * @since 1.8
 8      */
 9     public class Doc{
10         String name;
11 
12         /**
13          * @author Xujie
14          * @param name
15          * @return
16          * @throws Exception
17          */
18         public String test(String name)throws Exception{
19             return name;
20         }
21         //通过命令行 javadoc 参数 Java文件生成Javadoc文档
22         //学会查找使用IDEA生产Javadoc文档！百度编程
23     }
24 }

用Doc生成文档