JetBrains Rider 2024.1 ヘルプ

コード検査: XML ドキュメントのコメントが無効です

通常のコメントとは対照的に、3 つのスラッシュ /// で始まる XML ドキュメントのコメントは特定の構造を持ち、サポートされている XML タグを使用する必要があります。

XML ドキュメントが正しく記述されている場合は、ツールを使用してコードベースのドキュメントを自動的に生成し、IDE でシンボルドキュメントを包括的に表示できます。

このインスペクションは、次のような XML ドキュメントコメント内のさまざまな問題を特定できます。

  • 閉じられていないタグ。

  • <see cref=""/> タグ内の不明またはあいまいな参照。

  • 一部の行では、3 重スラッシュではなく 2 重スラッシュが使用されています

これらの問題はすべてコードの機能には影響しませんが、コードの保守性と API の使いやすさを向上させるために対処する価値はあります。

関連ページ:

コードインスペクション設定を構成する

設計時コードインスペクションを構成する:デフォルトでは、JetBrains Rider はサポートされている言語に対応するすべてのファイルで設計時コードインスペクションを有効にします。必要に応じて、無効にすることができます。設計時コードインスペクションが有効かどうかにかかわらず、コードインスペクションを特定の範囲でいつでも実行できます。「鉛筆」ウィジェットを使用して、エディターから直接インスペクション設定をすばやく調整するか、設定でより詳細な構成を行うことができます。を押すか、メニューから(W...

クイックドキュメント

JetBrains Rider を使用すると、エディター内でシンボルのドキュメントをすばやく確認できます。シンボルがサポートされている形式 (C# の XML-docs など) でドキュメント化されている場合、すべてのドキュメントが適切な形式で表示されます。それ以外の場合は、基本的なシンボル情報が表示されます (完全なメソッドシグネチャーまたは型の可視性と名前空間など)。デフォルトでは、シンボルの上にマウスを置くと、クイックドキュメントポップアップが表示されます。これを無効にして常にポップアップ...

コード検査: プロパティは init のみにすることができます (非公開アクセシビリティ)

このインスペクションは、コンストラクターでのみ初期化されるプロパティを識別し、そのアクセサーをアクセサーに置き換えることを提案します。C# 9.0 以降のアクセサーを使用すると、以前よりも柔軟な方法でプロパティを不変にすることができます。フィールドや get-only プロパティとは異なり、init-only プロパティはオブジェクトの初期化中にのみ設定できます。これにより、オブジェクトの作成後にオブジェクトの不変性が維持され、より安全でシンプルなコードが実現します。public class B...