工作學習筆記(十八)Java中的註釋

小张不嚣张。發表於2024-12-02

什麼是 Java 文件註釋?

在 Java 中,文件註釋是一種特殊的註釋形式,它以/**開頭,以*/結尾,用於為程式碼生成 API 文件,方便其他開發者理解程式碼的功能、引數、返回值等重要資訊。通常會被一些文件生成工具(如 Javadoc 工具)讀取並處理,進而生成格式規範、易於檢視的 HTML 格式的文件。

  • 常用標籤介紹:

  • @author:
    用於指定程式碼的作者名字,像上述示例中可以表明這個類或者相關程式碼是誰編寫的。例如:@author 張張張,表示作者是 張張張。

  • @version:
    用來記錄程式碼的版本號,方便追蹤程式碼在不同階段的變化情況,比如:@version 2.3,說明當前版本是 2.3 版本。

  • @param:
    當方法有引數時,使用這個標籤來描述引數的含義、型別以及用途等資訊。如上述myMethod方法中的@param num,就是對引數num進行說明,讓使用者知道這個引數是幹什麼的。

  • @return:
    針對有返回值的方法,用它來說明返回值的情況,像返回的資料型別、代表的含義等。例如myMethod方法裡的@return註釋,告知呼叫者該方法會返回一個經過計算後的整數結果。

  • @throws(或@exception):
    如果方法可能丟擲某些異常,就可以用這個標籤來列舉出可能丟擲的異常型別以及異常產生的原因等情況,

相關文章