程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> java的方法文檔標記

java的方法文檔標記

編輯:關於JAVA

除嵌入HTML和@see引用之外,方法還允許使用針對參數、返回值以及違例的文檔標記。

1. @param
格式如下:
@param 參數名 說明
其中,“參數名”是指參數列表內的標識符,而“說明”代表一些可延續到後續行內的說明文字。一旦遇到一個新文檔標記,就認為前一個說明結束。可使用任意數量的說明,每個參數一個。

2. @return
格式如下:
@return 說明
其中,“說明”是指返回值的含義。它可延續到後面的行內。

3. @exception
有關“違例”(Exception)的詳細情況,我們會在第9章講述。簡言之,它們是一些特殊的對象,若某個方法失敗,就可將它們“扔出”對象。調用一個方法時,盡管只有一個違例對象出現,但一些特殊的方法也許能產生任意數量的、不同類型的違例。所有這些違例都需要說明。所以,違例標記的格式如下:
@exception 完整類名 說明
其中,“完整類名”明確指定了一個違例類的名字,它是在其他某個地方定義好的。而“說明”(同樣可以延續到下面的行)告訴我們為什麼這種特殊類型的違例會在方法調用中出現。

4. @deprecated
這是Java 1.1的新特性。該標記用於指出一些舊功能已由改進過的新功能取代。該標記的作用是建議用戶不必再使用一種特定的功能,因為未來改版時可能摒棄這一功能。若將一個方法標記為@deprecated,則使用該方法時會收到編譯器的警告。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved