聲納，Java和'尾隨評論'違規

Question

在我的一個項目上運行聲納後，我收到了'尾隨評論'的違規問題。所以我想知道，這是純粹與Java的接受/推薦的代碼佈局約定相關嗎？還是「還有更多」？它背後的理由是什麼？當我查看一些C++代碼時（最近的Doom code review，後面的註釋有很多（或全部）尾部註釋

Answer 1

從名著Code Complete：

• 的意見必須對齊，使他們不與代碼的視覺結構干涉。如果你沒有整齊地對齊它們，他們會讓你的列表看起來像是通過洗衣機。

• 終端註釋通常難以格式化。調整它們需要時間。這段時間並沒有花費更多的時間來學習代碼。它專門用於按空格鍵或製表鍵的繁瑣任務。

• 終端評論也很難維護。如果任何包含endline註釋的行上的代碼都會增長，它會將評論更加顛簸，而其他所有的endline註釋將不得不相互匹配。不能維護難以維護的風格。

• 終端評論也往往是神祕的。該行的右側沒有提供太多空間，並且希望將評論保留在一行上意味着評論必須簡短。然後，工作將盡可能縮短生產線，而不是儘可能清楚。評論通常會盡可能地隱祕。

• endline註釋的一個系統性問題是很難爲一行代碼寫一個有意義的註釋。大部分的endline評論只是重複了代碼行，這不僅僅有助於它。

話雖如此，它也對一個人的選擇有關的編碼風格。我會親自避免尾隨評論，因爲他們不幫那多。

Answer 2

尾隨註釋本身沒有什麼不好但是，你應該儘可能清晰地編寫你的代碼，你不必通過線使用註釋來解釋你的代碼行。這就是爲什麼有些人認爲尾隨代碼註釋作爲提示，代碼是不夠的理解。

又見Java Style Guide，瞭解有關詳情。

Answer 3

僅僅因爲有東西有尾隨評論並不意味着他們是goo d。另外請記住，Doom 3的代碼已經有10年了，編碼風格隨着時間而改變。

通常，尾隨註釋表示一行代碼不能獨立存在。一般來說，這是一種代碼異味，因爲一行代碼應該是相當透明的。

翻看一些源代碼我實際上並沒有看到大量的尾隨評論，儘管我看到很多方法太長，並且在函數中間有很多評論。

這些經常表明下面的代碼值得自己的方法。

我會爭辯說，是的，還有更多，「更多」是溝通和清晰。