2011-07-07 3 views
5

私はRubyで書かれた専門的なコードを見直し、コメントは見つけられませんでした。このコードは読みやすいとはっきりしていましたが、自己文書化はできませんでした。専門的に書かれたRubyコードにコメントが必要なのでしょうか?または、コメントが必須とは見なされないRubyの教義がありますか?良いRubyコードにはコメントがないと受け入れられますか?

+2

関連性:http://rubyrogues.com/what-makes-beautiful-code/ –

+0

@Close Voter:これはオフトピックですか? –

答えて

5

この問題は、Rubyに固有の問題ではありません。

コードコメントは、コードが変更されたときには通常更新されず、参考になるよりも誤解を招くため、絶対に最低限に抑える必要があります。

あなたが既に提案したように、最良のコードは自己文書化であり、コメントは必要ありません。

編集:明確にするために、複雑さを取り除くためのコードを減らすことができない場合、にコメントを提供する必要があります。これは私の経験ではまれなことですが、通常、外付けコンポーネントが予期したとおりに動作しない場合にのみ適用されます。

+2

コメントは、異なる結果が予想されるコードでのみ使用してください(たとえば、浮動小数点精度エラーを処理する場合)。 –

+3

コメントはコードの変更に関して最新の状態に保たれるべきであり、それは大きな努力ではなく、コメントを書いていないという言い訳をするのに十分な大きさではありません。 OPは確かにベストコードが自己文書化していることを示唆していません。 –

+3

自己文書化コードは、簡単な作業のために実行可能です。任意の複雑なコード*はいくつかのコメントが必要です。 –

5

Rubyの作成者であるMatz氏は、「ソースコードはドキュメントであり、すべてのバグも正しく記述しています」と述べています。そして彼はおそらくコメントのためにそれを意味するでしょう。私はRubyのソースコードにコメントしていない多くの人が彼の言葉に従っていると思います。あなたが彼に従うかどうかはあなた次第です。

Ruby入門Webサイトでは、コメントする必要があると感じるたびに、その方法を個々の方法と同じように分割し、その部分をコメントするときに名前を付けるべきだという噂を紹介しました。

+1

お見積もりありがとうございます!私はまだ彼の議論を買わない(私のビューコードでは、どのように/理由についての偉大なドキュメンテーションになることができますが、理由と理由はありません)が、これはRubyで受け入れられている練習であるという意味で私の質問に答えました世界。 – mikera

+1

まあまあ!私はこの問題に関するあなたの見解に完全に同意しています@sawa –

+1

合意。 *インテント*が明確でない場合はコメントを使用してください。良いコードではコメントが少なくて済みます。 –

関連する問題