第五天

JavaDoc

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

 

参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

 

 package com.kuang.base;
 ​
 /**
  * @author Kuangshen
  * @version 1.0
  * @since 1.8
  */
 public class Doc {
 ​
     String name;
 ​
 ​
     /**
      * @author kuangshen
      * @param name
      * @return
      * @throws Exception
      */
 ​
     public String test(String name) throws Exception{
         return name;
     }
     //我是通过 命令行 javadoc 参数 Java 文件
 ​
     //作业：学会查找使用IDEA生成JavaDoc文档！
 ​
     //基础部分的一切知识，后面几乎每天都会用
 }