首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
您现在的位置: 程式碼之家 >> 編程語言 >  >> Java 程式設計 >> Java 相關知識

Javadoc 註釋格式:/** ... */、三類文檔位置、public/protected 限制

     編輯:Java 相關知識

基本格式

  • 起始:/**
  • 結束:*/
  • 僅此格式被 Javadoc 識別,普通 /* */ 或 // 會被忽略

兩種內容形式

  1. 嵌入 HTML:直接撰寫 HTML 標籤
  2. 文檔標籤:以 @ 開頭的命令(如 @param),置於註釋行首(前導 * 會被忽略)

三類文檔註釋與位置

類型位置範例
類註釋類定義之前/** 類註釋 */ public class X {}
變數註釋變數定義之前/** 變數註釋 */ public int i;
方法註釋方法定義之前/** 方法註釋 */ public void f() {}

可見性限制

  • Javadoc 預設只處理 public 和 protected 成員
  • private 和 package-private(友好)成員被忽略
  • 可用 javadoc -private 強制包含 private
  • 所有類註釋均會輸出(無論修飾符)

輸出結果

標準格式 HTML 文件,與官方 Java API 文檔風格一致,使用者熟悉度高。

  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved