《Java 編程思想》003 Java註釋和嵌入式文檔

與您共讀《Java 編程思想》 Page30~37

JDK中提供了javadoc,便於維護代碼文檔,可以進行代碼註釋的提取,輸出一個HTML文件。

javadoc命令只能用在/***/的註釋中出現。

  • 使用方式
    • 嵌入式HTML
    • 文檔標籤
  • 位置
    • @命令寫在出”*”的最前面
    • 行內文檔標籤可以在任意地方,但在花括號內
  • 類型
    • 類註釋
    • 域註釋
    • 方法註釋
  • 標籤實例
    • @see classname 引入其它類,鏈接到其他文檔
    • {@link package.class#member label} 類似於see,行內 label作爲超鏈接
    • @docRoot 產生相對文檔跟目錄的相對路徑
    • @inheritDoc 繼承直接繼承類的文檔
    • @version
    • @author
    • @since 指定代碼最早版本
    • @param
    • @return
    • @throws
    • @Deprecated 建議用戶不在使用的舊的特性

《Java 編程思想》第一章對象導論、第二章一切皆對象讀完。

第一章主要是背景性和補充性的資料。引入各種概念更好了幫助讀者瞭解OOP思想。對於面向對象中的類和接口的抽象過程、繼承和多態等基本概念做了清晰的闡述。第二章則闡述了Java一切皆對象的基本思想,講解了Java的數據類型等概念,並提供簡單的實例幫助讀者瞭解Java的編程知識。

發佈了39 篇原創文章 · 獲贊 4 · 訪問量 2萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章