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

Javadoc 核心觀念:Java 「自文件化」技術的設計哲學與文件結構

     編輯:Java 相關知識

傳統詳細設計文件與原始碼分離,一致性難維護。Javadoc 以「寄生於原始碼的註解」為核心,實現自文件化:程式碼異動時順手更新註解,文件永遠同步。本文深入解析 JDK 標準 Javadoc 文件結構與 JBuilder 支援功能。

JDK API 文件架構解析

打開 <JBuilder>/doc/jdk_docs.jar 解壓後的 index.html,三框架結構:

  • 左上:套件列表
  • 左下:類別/介面列表
  • 右側:主內容區

導航列常用頁面

頁面用途
Overview所有套件說明列表
Package套件內類別/介面列表
Class當前類別(無連結)
Use類別關聯:繼承、依賴、關聯
Tree繼承/實作階層樹
Deprecated所有過時 API
Index字母序索引,快速定位
HelpJavadoc 使用說明

標準類別 Javadoc 文件內容項目

  1. 導航列(頁首/頁尾,含錨點連結)
  2. 類別繼承關係:繼承樹、實作介面、子類別
  3. 類別簡要說明
  4. 內部類別列表
  5. 欄位摘要
  6. 建構子摘要
  7. 方法摘要
  8. 繼承方法列表
  9. 欄位詳細說明
  10. 建構子詳細說明
  11. 方法詳細說明

JBuilder 內建 Javadoc 支援功能

  • 快捷鍵產生類別/方法/欄位/建構子註解骨架(含對應標籤)
  • JavadocInsight:標籤輸入提示
  • 快捷鍵插入 @todo 並瀏覽管理
  • 衝突偵測與一鍵修復
  • Archiver Builder 產出專案完整 Javadoc
  • 自訂標籤擴充
  • Doc 瀏覽器即時預覽

為什麼選擇 Javadoc?

「程式碼與註解同檔」是關鍵。編碼時調整註解舉手之勞,一致性成本極低。這正是享元模式思想在文件層面的體現:單一事實來源。

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