Javadoc是一個實現外部接口的類，它不是您爲其編寫的源代碼？

Question

如果我的類實現了外部庫（我沒有寫過）的良好文檔化的外部接口，例如AttributeConverter從javax.persistence，我想知道正確的方法來記錄我的覆蓋方法。我是否使用@inheritDoc或者非javadoc註釋塊，或者根本不需要文檔，因爲可以很容易地找到文檔，什麼是正確的方法？

Answer 1

這取決於你正在嘗試做什麼。你必須問自己的第一個問題是：我有什麼要添加到父母Javadoc？

如果答案是「否」，這是基於某種意見。如果你只是放棄它，只要你使用@Override就會使用父母Javadoc。關於結果，評論變得不切實際。它仍然是它在源代碼中的目的。見Should I use a "non-Javadoc" comment?

@inheritDoc在這種情況下不是有用的，因爲它只複製它使用的元素。從documentation：

插入的方法描述主或@return，@參數或@throws標記註釋的內置代碼{@inheritDoc} - 相應的繼承主描述或標籤評論被複制到該點。

它發揮作用，如果你想添加一些父母的文件。用它在您自己的評論中插入父母文檔。