Day10-JavaDoc
JavaDoc介紹
JavaDoc：
javadoc 命令是用來生成自己 API 文件的。
javadoc 是一個工具，它可以讀取原始碼中的文件註釋，並將其轉換為格式規範的 API 文件。javadoc 透過解析文件註釋中的特定標記，如 @author、@version、@since、@param、@return、@throws 等，來提取關鍵資訊，生成易於閱讀和理解的文件。
引數資訊：
-
@author：作者名。
-
@version：版本號。
@since：指明需要最早使用的 jdk 版本。
@param：引數名。
@return：返回值情況。 -
@throws：異常丟擲情況。
JavaDoc生成
package com.liu.www.basic;
/**
* @author liu
* @version 1.0
* @since
*/
public class Doc {
String name;
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
1.命令列生成
D:\IDEA\example\JavaSE\Basic Grammar\src\com\liu\www\basic>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
這是一個在命令提示符或終端中執行的命令，用於為特定的 Java 原始檔生成文件。 具體解釋如下： - “D:\IDEA\example\JavaSE\Basic Grammar\src\com\liu\www\basic>”是當前命令執行的路徑，表示命令提示符或終端當前所在的目錄是這個路徑。
-
“javadoc”是用於生成 Java API 文件的工具。
-
“-encoding UTF-8”指定輸入原始檔（即 Java 原始檔）的編碼為 UTF-8，確保能夠正確處理可能包含非 ASCII 字元的原始檔內容。
“-charset UTF-8”通常指定生成的文件的字元編碼為 UTF-8，保證生成的文件中的字元能正確顯示和被不同的系統和工具處理。
- “Doc.java”是要生成文件的 Java 原始檔的名稱。這個命令會讀取“Doc.java”檔案中的文件註釋，並生成相應的 API 文件。
總結：
javadoc 引數 Java檔案
2.IDEA裡面生成
（暫時不寫）