Java的註釋使用

一、簡介
註釋，即對程序的說明信息，如類、方法等的功能、創建者、創建時間、作用、修改記錄等信息的說明。
添加必要的代碼註釋對程序進行解釋說明，增強了代碼的可讀性。
Java註釋分爲單行註釋、多行註釋和文檔註釋。

二、單行註釋
單行註釋用//進行標註。

// 用於指定連接的超時時間
public static final int TIME_OUT_SECONDS = 3000;

說明：

• 單行註釋不參與編譯
• 編譯以後生成的.class結尾的字節碼文件中不包含註釋掉的信息

三、多行註釋
多行註釋利用/* */進行標註。

/*
 * 多行註釋
 * 用於說明方法的功能、作者、開發時間等信息，可以寫多行
 */

說明：

• 多行註釋不參與編譯
• 多行註釋不可以嵌套使用
• 編譯以後生成的.class結尾的字節碼文件中不包含註釋掉的信息

四、文檔註釋
文檔註釋用/** */進行標註。

/**
 * @Note {類、方法等的功能描述信息}
 * @author giserDev
 * @Date 2020-06-20 18:05:33
 */

說明：

• 文檔註釋的內容可以被JDK提供的javadoc工具解析，生成網頁形式的程序說明文檔。
• 命令格式爲：　
  javadoc [options] [packagenames] [sourcefiles] [@files]
  -overview 從 HTML 文件讀取概覽文檔
  -public 僅顯示 public 類和成員
  -protected 顯示 protected/public 類和成員 (默認值)
  -package 顯示 package/protected/public 類和成員
  -private 顯示所有類和成員
  -help 顯示命令行選項並退出
  -doclet 通過替代 doclet 生成輸出
  -docletpath 指定查找 doclet 類文件的位置
  -sourcepath 指定查找源文件的位置
  -classpath 指定查找用戶類文件的位置
  -cp 指定查找用戶類文件的位置
  -exclude 指定要排除的程序包列表
  -subpackages 指定要遞歸加載的子程序包
  -breakiterator 計算帶有 BreakIterator 的第一個語句
  -bootclasspath 覆蓋由引導類加載器所加載的
  類文件的位置
  -source 提供與指定發行版的源兼容性
  -extdirs 覆蓋所安裝擴展的位置
  -verbose 輸出有關 Javadoc 正在執行的操作的信息
  -locale 要使用的區域設置, 例如 en_US 或 en_US_WIN
  -encoding 源文件編碼名稱
  -quiet 不顯示狀態消息
  -J 直接將 傳遞到運行時系統
  -X 輸出非標準選項的提要