問題タブ [comments]

他の人に自分のコードにコメントするよう説得するための良い議論は何ですか?

多くのプログラマーが、自分自身や他の人のためにドキュメントを残すよりも、コメントなしでコードを書くことの認識速度を好むことに気付きました。私が彼らを説得しようとすると、「メソッド/クラス名はそれが何をするかを示すべきだ」などの生半可なことを聞​​くようになります。

コメントに反対の場合は、コメントを残してください。これは、他の方法ではなく、コードにコメントするよう人々を説得しようとする人々のためのリソースであるべきです. :-)

その他の関連する質問は次のとおりです: Commenting code , Do you comment your codeおよびHow would you like your comments .

F# を調べているところなので、ばかげた質問でしたら申し訳ありませんが、VS2008 F# CTP 1.9.6.2 'Tutorial' プロジェクトでは、 // と /// の両方がコードのコメントに使用されます。

2 つのスラッシュと 3 つのスラッシュのコメントの間に機能的な違いはありますか、それとも (チュートリアル コードに表示されているように) /// で関数をコメントし、他のすべてに // を使用するのは慣例ですか?

あなたがこれまでに遭遇したソース コードの中で、最も優れたコメントは何ですか?

私は何年にもわたって学校を卒業し、業界で働いてきたので、コメントについて人々にアドバイスを求めることがよくありました. 悲しいことに、私たち全員が知っているように、多くの開発者とコメントすることは、補足的なものであり、それ以外のことではありません. そうは言っても、私は通常、かなり一般的な答えを得ます。実際、時間が経つにつれて何が本当に役立つかを確認するのに、これはあまり役に立ちません。

では、Visual Studio を使用して C# を構築し、コメントを作成する最良の方法は何だと思いますか?

私は wordpress ブログを持っており、stackoverflow にコメントを追加するのと同じユーザー エクスペリエンスを人々に提供したいと考えています。そこには多くのコメント ajax プラグインがありますが、メイン ページにインライン化して、最初に個別の単一の投稿ページにドリルダウンせずにコメントを追加できる機能を見つけることができません。

これを行うには、wordpress プラグインまたは php コードを使用して、誰でもここで手伝ってもらえますか。

どこかでコメントを追加することはできますか？

MySQL を使用するとき、私は専門家のふりをするつもりはありません。列 (通常はビット列) をどのように使用するかを忘れてしまうことがよくあります。たとえば、1 が良いか悪いかを思い出させるコメントを追加できれば非常に興奮します。

「show create table」のようなものにのみ表示されれば幸いですが、テーブル構造内のあいまいな場所は、現在デスクにあるポストイット ノートよりも見つけやすくなります。

自分のコードにはコメントは必要ないと主張する同僚がいます。それは「自己文書化」です。

私は彼のコードをレビューしましたが、他の人が作成したコードよりも明確ではありますが、自己文書化コードがコメントや文書化されたコードと同様に完全で有用であることに同意しません。

彼の見解を理解するのを手伝ってください。

• 自己文書化コードとは
• 十分にコメントされ、文書化されたコードを本当に置き換えることができますか
• 十分に文書化され、コメントされたコードよりも優れている状況はありますか?
• コードがコメントなしで自己文書化できない例はありますか

多分それは私自身の制限に過ぎませんが、それがどのように良い習慣になるかわかりません。

これは議論を意図したものではありません - 十分にコメントされ、文書化されたコードが優先される理由を持ち出さないでください - これを示す多くのリソースがありますが、私の仲間には説得力がありません. そうではないと彼を納得させるには、彼の視点をもっと完全に理解する必要があると思います。必要に応じて新しい質問を開始しますが、ここで議論しないでください。

また、自己文書化コードに反対している人たち - これは主に、自己文書化コードの伝道者の視点 (つまり、肯定的な側面) を理解するのに役立つためです。

コードにコメントを入れたいのですが、デプロイする前にコメントを削除してください。はい、そのようなことを書くのは難しいことではありませんが、既に存在する場合は... ASP ページのコメントはどうですか?

たとえば、C# または JavaScript ドキュメントで。
そうでない場合、ASP.NET プログラミングでJavadocコメントを使用する意味はありますか?

そのため、bValidateFields（）関数の呼び出しを入力すると、VisualStudioのインテリセンスにコメントが表示されません。しかし、これによると、そうすべきです。それが必要ですか？