私のプロジェクトの 1 つでソナーを実行した後、「末尾のコメント」の違反が発生します。だから私は、これは純粋に Java の受け入れられた/推奨されるコードレイアウト規則に関連しているのか、それとも「それ以上」のものがあるのだろうか? その背後にある理由は何ですか？いくつかの C++ コード (最近のDoom コード レビュー) を見ていると、大量の (またはバインダーがいっぱいの) 末尾のコメントがあります。
4594 次
3 に答える
16
有名な本からCode Complete：
コメントは、コードの視覚的な構造を妨げないように配置する必要があります。きれいに並べないと、商品が洗濯機で洗ったように見えてしまいます。
エンドライン コメントは、書式設定が難しい傾向があります。それらを揃えるには時間がかかります。そのような時間は、コードについてさらに学習するのに費やされません。スペースバーまたはタブキーを押すという面倒な作業専用です。
エンドラインのコメントも維持するのが難しいです。エンドライン コメントを含む行のコードが大きくなると、コメントがさらに外側に突き出され、他のすべてのエンドライン コメントが一致するように突き出さなければならなくなります。維持するのが難しいスタイルは維持されません。
エンドラインのコメントも不可解になりがちです。行の右側にはあまりスペースがありません。コメントを 1 行に収めたい場合は、コメントを短くする必要があります。次に、線をできるだけ明確にするのではなく、できるだけ短くする作業が行われます。コメントは通常、可能な限り不可解なものになります。
エンドライン コメントの体系的な問題は、コードの 1 行に意味のあるコメントを書くのが難しいことです。ほとんどのエンドライン コメントは、コード行を繰り返すだけであり、これは役立つどころか害を及ぼします。
そうは言っても、それはコーディングスタイルについての選択でもあります。あまり役に立たないので、個人的には末尾のコメントは避けたいと思います。
于 2013-01-17T18:21:41.403 に答える
5
末尾にコメントがあるからといって、それが良いとは限りません。また、Doom 3 のコードは 10 年ほど前のものであり、コーディング スタイルは時間の経過とともに変化することにも注意してください。
一般に、末尾のコメントは、コード行がそれ自体では成り立たないことを示しています。そして、一般的に、これはコードのにおいです。なぜなら、コードの 1 行はかなり透過的でなければならないからです。
ソースの一部を調べてみると、実際には大量の末尾のコメントは見られませんが、長すぎるメソッドが多く、関数の途中に多くのコメントが見られます。
これらは、多くの場合、次のコードが独自の方法に値することを示しています。
はい、それだけではありません。「もっと」とは、コミュニケーションと明確さです。
于 2013-01-17T18:21:24.753 に答える
4
末尾のコメント自体は悪いことではありません。ただし、コメントを使用して行ごとにコードを説明する必要がないように、コードをできるだけ明確に記述する必要があります。そのため、末尾のコード コメントは、コードが十分に理解できないことを示すヒントであると考える人もいます。
詳細については、Java スタイル ガイドも参照してください。
于 2013-01-17T18:17:09.227 に答える