私が見た、これはSO居酒屋に尋ねたので、私はここに質問を投稿しています。面白い質問だと思いました。(もちろん、SOに属していませんが、ここでは問題ないと思います。)
コードコメントにピリオドを追加しますか(またはOPが書いたように「フルストップ」)。
関連性を保つために、なぜですか?
私が見た、これはSO居酒屋に尋ねたので、私はここに質問を投稿しています。面白い質問だと思いました。(もちろん、SOに属していませんが、ここでは問題ないと思います。)
コードコメントにピリオドを追加しますか(またはOPが書いたように「フルストップ」)。
関連性を保つために、なぜですか?
回答:
完全停止は文を終了するためのものですが、コメントがコードで囲まれた1つの文だけで構成される場合、完全停止は私の意見では必要ありません。時々、最初の文字を大文字にしないこともあります。一方、詳細な複数行コメントには、完全な句読点が必要です。
// This function returns an average of two integers. Note that it may
// return an irrelevant result if the sum of a and b exceeds the int
// boundaries.
int avg(int a, int b) // make it static maybe?
{
// A better algorithm is needed that never overflows
return (a + b) / 2;
}
はい、コメントは英語であり、適切な英語では句読点を使用しているためです。
コードコメントにピリオドを追加しますか(またはOPが書いたように「フルストップ」)。
関連性を保つために、なぜですか?
同じ理由で、「通常の」テキストを書くときにそれらを追加します-それらは、書面での言語の一部であり、それらについて特別なものはないはずです。1つの文(1行)のコメントと段落全体を書くときに、それらを等しく使用します。
ソースコードは通常のテキストではないため、異なるルールを使用します。シンプル;-)
完全な文(またはそれ以上)を書く場合、はい。そうでない場合、時々いいえ、しかし通常はい。
私も時々気が狂って、感嘆符、疑問符などを使用します;)
理由については、その理由の一部は、私がそのような特定の理由だけでなく、適切な句読点が多くの明確さを追加できることを発見したからです。
他の回答とその人気は、長いコメントでは完全な停止が高く評価され、おそらくワンライナーでは回避できることを明らかにしました。
関連する可能性がある別のポイントは、感嘆符、特に倍数を避けることです。例:
// Though loop is labor-intensive, performance is fine with with 95K cases!!!
そして
// This code really sucks!
一方、疑問符は時々非常に便利です。
// TODO: What does Crojpler.bway() actually do?
場合によります。コードのブロックが何をするかを説明する大きな適切なパラグラフを作成する場合、他の適切な記述のように、適切に句読点を付けます。OTOH、1行のコードにコメントするだけで、コメントはしません。
どうして?-SMSメッセージで短い文章を使用する一方で、適切な文章を使用してメールを作成する理由と同様です。あるケースでは、適切なテキストブロックを作成するために座っているので、自動的に「適切に実行」しますが、別のケースでは、わかりやすくするための短いメモです。
私のコードからの実際の例:
クイックノートコメント:
// check for vk_enter
「適切な」メソッドのドキュメント:
// This method sets up a workspace tab with the given name. Each MDI window has a parent
// workspace specified when it's saved. The code which loads each MDI window then point it to
// the correct workspace.
IntelliSenseおよび生成されたドキュメントで見られると思われるXMLコメントを作成するときは、常に適切に大文字と句読点を使用します。これらははるかに形式的な構造であり、そのように扱われるべきです。
ただし、コードブロックの本文に見られるコメントは、できるだけ明確にする必要があります。それを達成する方法はプログラマ次第です。