如何記錄覆蓋另一種方法的方法？

Question

我總是想知道如何記錄一個覆蓋基類消息的方法。 通常我會向每個公共方法和一些私有的受保護方法添加一個java文檔。

但autogenerating一個文件塊在Eclipse中的覆蓋方法產生這樣的：

/* 
* (non-Javadoc) 
* 
* @see javax.swing.JComponent#paintComponent(java.awt.Graphics) 
*/ 

這是記錄覆蓋的好辦法？我應該從基類繼承/複製文檔嗎？

作爲這種特殊情況的文檔，你在做什麼？ 我想概述一下使用的實踐。

Answer 1

每種方法 - 私人的，受保護的公共 - 都應該形成文件來描述它的功能。忘記從基類繼承文檔 - 如果你願意，你可以包含一個鏈接，但只要信息覆蓋了繼承的方法，那麼另一個人就可以自由地查找它。幹 - 不要重複自己 - 只在一個地方記錄基類方法。

我甚至不認爲記錄它覆蓋的方法是好的，因爲這可能會改變，如果在類和基類之間的層次結構中插入新類，將難以保持最新狀態。只是它覆蓋繼承方法的信息就足夠了。

如果您的方法過於複雜，無法在幾行註釋中記錄，那麼它們可能太複雜，應該重構。

Answer 2

包括@Override註釋應該足以讓一個好奇的開發人員發送給超級用戶。