java中的清潔方法聲明

Question

我想編寫乾淨的代碼。所以在編寫一個方法時，我想告訴調用者有關參數，返回類型，異常等的方法。當調用一個方法時，調用者應該已經知道方法是否可以返回null或者參數是否爲null。

我可以在javadoc中解釋這一點，但我想用註釋做到這一點。我知道jetbrains，現在JSR305試圖解決這個問題，但我認爲它們還不夠。

所以：

1. 是否有任何大的註釋庫，參數和返回類型

2. 是這個註釋只針對代碼只可讀性，或者它拋出一個異常，如果一個意想不到的價值/運行時遇到結果？

3. 方法聲明只應包括鹼檢查異常或亞類的它太像

   public void foo() throws ConnectionException, AuthenticationException { 
   } 
   
   public class AuthenticationException extends ConnectionException { 
   } 
   

Answer 1

這可能是也可能不是你心目中 - 設計 - 通過合同註解允許你指定的參數和返回的方法的類型必須滿足一定的條件，被認爲是正確的。看看cofoja：

Java合同使您能夠以預處理，後置條件和不變式的形式對合同進行註釋。

這些合同註解

• 易於讀寫，
• 並在運行時檢查。

與合同註解代碼可以幫助你：

• 設計，
• 文件，
• 測試和
• 調試

您的程序。

Answer 2

關於「3」：一種方法，文件應包括通過所述方法引發的所有可能的例外，即，選中並未檢查。

關於「2」：註釋不是允許在運行時拋出異常的機制。它們有三個主要目的：爲編譯器生成樣板代碼，文檔和信息，從而生成警告。看看這裏：

Annotations Tutorial

Answer 3

給我打電話給老學校。但是，這不是javadoc的用途嗎？