ソナー、Javaと '後続のコメント'違反

Question

私のプロジェクトの一つでSonarを実行した後、私は「後書き」の違反を受けます。だから、これは純粋にJavaの受け入れられた/推奨されるコードレイアウトの規約に関連しているのでしょうか？その背後にある理由は何ですか？私はいくつかのC++コード（最近のDoom code reviewを見ていると、後ろのコメントのトン（またはバインダーでいっぱいです）があります。

Answer 1

：

• のコメントは、彼らは、コードの視覚的な構造に干渉しないように整列する必要があります。それらをきれいに整列させないと、洗濯機を使用しているように見えます。

• エンドラインのコメントはフォーマットするのが難しい傾向があります。それらを整列するのに時間がかかる。そのような時間はコードについてもっと学ぶために費やされません。スペースバーまたはタブキーを押すという面倒な作業に専念しています。

• エンドラインコメントも維持するのは難しいです。エンドラインコメントを含む行のコードが大きくなると、そのコメントはより遠くまでバンプされ、他のすべてのエンドラインコメントは突き合わせて一致する必要があります。維持しにくいスタイルは維持されません。

• エンドラインのコメントもまた、わかりにくい傾向があります。行の右側に余裕がなく、コメントを1行に保存したいという欲求は、コメントが短くなければならないことを意味します。できるだけ明確なものではなく、可能な限り短くする作業が行われます。コメントは、通常、できるだけ秘密に終わる。

• endlineコメントに全面的な問題は、1行のコードに対して意味のあるコメントを書くのは難しいということです。ほとんどのエンド・ラインのコメントは、コードの行を繰り返すだけです。

それはコーディングスタイルについての自分の選択についてもだ、と述べました。私は個人的に彼らが助けてくれないので、後ろのコメントを避けるだろうその多く。

Answer 2

後ろのコメント自体は何も悪いものではありません。あなたは何人かの人々は、コードが十分に理解できていないことをヒントとしてコードのコメントを末尾考える理由です。コメントを使用して線で、あなたのコード行を説明する必要はありません。

が、その詳細については、またJava Style Guideを参照してください。

Answer 3

ちょうど何かがの後ろにあるコメントは、彼らがのgoo d。また、Doom 3のコードは10歳であり、コーディングスタイルは時間とともに変化することにも留意してください。

一般に、後続のコメントは、コード行が単独では立つことができないことを示しています。そして、一般的にはコードの臭いです。コードの1行は、がかなり透明でなければならないからです。

私は実際にはそうではありませんを参照してください。長すぎる方法がたくさんありますが、機能の途中でたくさんのコメントがあります。

多くの場合、次のコードでは独自の方法が必要です。

私は、それ以上のことがあると主張し、「より多く」はコミュニケーションと明快さです。有名な本Code Completeから