Java doc模式

Question

我通過將某些方法移動到不同的類來重構類。因爲這就像是架構重構而不是代碼重構，所以我想知道在新類的javadoc中提到它是否包含從先前存在的X類移出的方法是一個好習慣？例如，

/** 將序列設置爲付款組的處理器。此處理器已添加爲checkout重構項目的一部分，xxxMethod（）方法已從{@link XXXFormHandler}移至此流水線處理器。 **/

我喜歡這種方法，因爲它給參與維護此代碼的任何開發人員提供了清晰的畫面。我唯一擔心的是，如果這是作爲API公開的，那麼這些信息將顯示給每個人。

Answer 1

我不認爲這是有用的。你有很強的理由來重構代碼，所以知道新代碼的開發人員不應該爲舊的架構而煩惱。只知道舊代碼的開發人員不知道他們必須在新代碼的哪個位置查找該javadoc，並且一旦他們知道了，他們就不再需要它了。所以他們需要一個獨立於javadoc的遷移指南。

關於最後一個問題，如果API用戶不應該看到特定的文檔，那麼定期評論會做維護者看到源代碼的評論。