javadoc

javadoc

1. 定义：javadoc命令是用来生成api文档的

2. 类注释和方法注释

   package com.sun.base;
   //以下是类注释
   /
   /**
    * @author sungh
    * @version 1.0
    * @since 1.8
    */
   public class Doc {
       String name;
   //以下是方法注释
       /**
        *
        * @param name
        * @return
        * @throws Exception
        */
       public String getName(String name) throws Exception {
           return name;
       }
   }
   

3. 参数

   @author 作者名

   @version 版本号

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

   @param 参数名

   @return 返回值

   @throws 异常抛出情况

4. 用命令行生成API文档

   • 打开类所在的文件夹，

   • 然后在路径前面加上cmd和空格后回车，打开命令

   • 输入以下命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.hava

     注意：Doc.hava 是类名

5. 用IDEA生成API文档
   

6. 百度搜索javajdk帮助文档

   https://docs.oracle.com/javase/8/docs/api/