萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> Java

Java 註釋完全指南:單行、多行、文檔註釋與 Javadoc 生成

三類註釋

類型語法用途
單行// 註釋內容簡短說明、臨時屏蔽代碼
多行/* 註釋內容 */大段說明、屏蔽代碼塊
文檔/** 文檔註釋 */生成 API 文檔,支持標記

三類註釋代碼示例

運行結果

文檔註釋標記

  • @author:作者
  • @version:版本
  • @see:參考鏈接
  • @param:參數說明
  • @return:返回值說明
  • @exception / @throws:異常說明

生成 API 文檔

javadoc -d docs -sourcepath src -subpackages com.example

javadoc 命令

生成的 API 文檔首頁

規範建議

  • 註釋佔比 ≥ 1/3,解釋「為什麼」而非「做什麼」。
  • 公共 API 必須寫文檔註釋。
  • 避免過時註釋,代碼變更同步更新註釋。
copyright © 萬盛學電腦網 all rights reserved