我最近才發現可以在 Javadoc 中為同一個例外使用多個@throws標簽。
我的一個學生用它來記錄他在連接四中的一種方法:
/*
* ...
* @throws IllegalArgumentException if the number of rows or columns is invalid
* @throws IllegalArgumentException if one of the players has {@link Stone#None} as stone
* @throws IllegalStateException if both players use the same stone color
*/
public void doSomething(...) { ... }
現在我的(和他的)問題:是否有官方風格指南或一般建議是否使用單個@throws標簽或“是否可以”為每個例外型別使用多個標簽?
uj5u.com熱心網友回復:
javadocs 有一個 Oracle 風格指南:
- 如何為 Javadoc 工具撰寫檔案注釋。
這是否算“官方”取決于您的觀點。無論哪種方式,我都看不到該檔案中提到同一例外的多個標簽。
但是,根據下面的 Q&A,標準 Javadoc 工具鏈支持@throws同一例外的多個標記;即,它們中的每一個都會在生成的 HTML 中產生一個條目。
- 我可以對 Javadoc 中的同一個例外使用多個 @throws 標簽嗎?
(我個人的看法是,如果你不這樣做,javadocs 會更具可讀性,但這只是我的看法。)
uj5u.com熱心網友回復:
我不確定這是否能回答你的問題,但這篇文章(恰好有一個帶有多個@throws相同例外的示例,盡管它不是文章的主題)建議你根本不應該記錄這些例外,因為它們未選中,檔案只會重復@param標簽的條件。
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/491000.html
