最近、私は///自分の C# コードにコメントを付けるために使用し//始めまし/*た。今日、なぜさまざまなタイプがあるのか 疑問に思い始め、コメントがxmlドキュメントを生成するためのものであると述べているこのSOの質問に出くわしました。///
コメントの種類と Google の別の種類に関するアドバイスを見つけることができません。それは、どちらの方法でも問題ではないことを意味します。コメントするのにこれまでのところ悪影響はありませんが、///後でそれを忘れるために今すぐ習慣になるのは嫌いです. 私が知る限り、コメントにメタタグがない場合、ドキュメントとして認識されません (または、完全に間違っていますか?)
コードを///コメントでなぞる前に、この種のコメントは絶対にダメですか? このようにコメントすることで潜在的な問題が発生する可能性はありますか?
このようにコメントすることで潜在的な問題が発生する可能性はありますか?
はい。プロジェクト ドキュメントを生成することを決定すると、XML ドキュメントの一部としてこれらすべてのコメント行が含まれます。拡張機能を使用してコードをコンパイルすると/Doc、XML コメント ( ///) を使用してドキュメントが生成されます。これを使用してコードをコメント アウトした場合、ドキュメント生成ではドキュメントのコメント アウトされたコードが考慮されます。
参照してください：
コードのコンパイルに関しては、技術的な違いはありません。それらはすべて無視されます。
///コメントは、XMLドキュメントコメントを使用して特定のコードブロックにコメントしていることを示すための慣例であると思います。Visual StudioなどのIDEは、さまざまなコメントタイプを認識するように調整されており、それに応じて視覚的にスタイルを設定します。
これが標準の//または/** /コメントを使用する一般的な慣習であるとすると、コードを読む他の開発者を混乱させる（または、おそらく煩わしい）可能性もあります。
たとえば resharper などの開発支援ツールを使用する場合、ほとんどの場合、コード ブロックにコメントを付ける機能が提供されます。これらのコメント//付き/* ... */のコード ブロックは、これらのツールを使用して切り替えることができます。 .
ドキュメンテーション シンボルの問題は別の問題です。コード内のコメントにとどまるものとドキュメンテーションに含まれるものを制御することなく、ドキュメンテーションで生成されたコメントを取得します///。ドキュメント生成ツールで構成します。