JavaDoc

• javadoc命令是用來生成自己的API文件的

• 引數資訊

  • @author 作者名

  • @version 版本號

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

  • @param 引數名

  • @return 返回值情況

  • @throws異常丟擲情況

  • package com.Base;
    ​
    /**
     * @author Sans
     * @version 1.0
     * @since 1.8
     */
    public class Doc {
      String name;
    ​
      /**
       *
       * @param name
       * @return
       * @throws Exception
       */
    ​
      public String test(String name) throws Exception{
        return name;
       }
    }
    ​
     
    

• 生成javadoc的方法

  • 在目錄下cmd：javadoc 引數 檔案 生成javadoc

    • javadoc -encoding UTF-8 -charset UTF-8 Doc.java

  • 在idea中生成

    • 1. 在工具欄中找到 tool >> Generate JAVADoc…

      2. 然後彈出配置視窗

      3.引數說明

      1. Whole project>>整個專案都生成

      2. Custom scope>>自定義範圍，如下：

         1. project files 專案檔案

         2. project production files 專案產品檔案

         3. project test files 專案的測試檔案， 未知範圍，class hierarchy 類層

      3. include test source 包含測試目錄

      4. include JDK and … 包含jdk和其他的第三方jar

      5. link to JDK documentation…連結到JDK api

      6. output directy 生成的文件存放的位置

         1. private、package、protected、public 生成文件的級別（類和方法）

         2. 右邊的Generate…是選擇生成的文件包含的內容，層級樹、導航、索引..

         3. 再右邊是生成的文件包含的內容資訊，作者版本等資訊

      7. Locale 語言型別,zh-CN

      8. Other command line arguments 其他引數

      9. Maximum heep… 最大堆疊