每一個方法拋出的異常都要有文檔(62)

描述一個方法所拋出異常,是這個方法(javadoc文檔)所需文檔重要組成部分java

  • 花時間爲每一個拋出的異常創建文檔很重要

始終單獨聲明每一個受檢的異常接口

  • JavaDoc 中使用 @throws標記,準確的記錄拋出每一個異常的條件
  • 不要懶省事拋出異常的超類,尤爲不要聲明 拋出 Exception 類 Throwable 接口

爲每一個未受檢異常創建文檔是理想狀態,不少時候作不到文檔

  • 若是沒有爲可拋出的異常創建文檔,其餘人很難使用你的類或接口
相關文章
相關標籤/搜索