Javadocs指定問題編號

我遇到了一個問題，它想要在我的java代碼中更改函數，問題編號例如＃41241。Javadocs指定問題編號

什麼是正確的Javadoc評論是指定問題編號，請求此更改？

只是在將來我知道，爲什麼某個函數或行被改變/創建？

2012-09-25 Jaanus

恕我直言，這取決於票務/錯誤跟蹤系統。我通常會像'/ **改變xyz這樣的註釋來解決問題＃123 * /'或'/ **，如問題AB01-345所述，這需要更改爲... * /'在Mylyn的幫助下，真的很不錯，因爲你可以直接跳到跟蹤系統中的相應問題。 –

請注意在源代碼註釋中添加錯誤編號。這是源控制系統的用途。在你添加這樣的評論後的6個月左右，它變得完全沒用，並且掩蓋了代碼。 – MaDa

我不會將問題編號寫入源代碼。當一個方法被因爲多個問題改變了這種可能很複雜......

我以前的發行數量增加了SVN提交，如：ISSUE-1234：添加NPE檢查。 Eclipse提供了有用的功能Team -> Show Annotations，它顯示了SVN提交已被更改的每一行以及提交註釋。在我看來，這在JavaDoc中添加了更多的好處。

2012-09-25 08:32:55 Kai

這是要走的路！ –

回答