ReSharper 2025.3 ヘルプ

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

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

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

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

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

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

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

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

2024 年 5 月 27 日

関連ページ:

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

設計時コードインスペクションを構成する:デフォルトでは、ReSharper は、サポートされている言語に対応するすべてのファイルで設計時コードインスペクションを有効にします。必要に応じて、無効にすることができます。設計時コードインスペクションが有効かどうかに関係なく、コードインスペクションは常に特定のスコープで実行できます。メインメニューからを選択するか、Alt+R O を押してから、左側のを選択します。設計時コードインスペクションを切り替えるには、コード分析を有効にするチェックボックスを使用し...

クイックドキュメント

ReSharper を使用すると、エディター内でシンボルのドキュメントをすばやく確認できます。シンボルがサポートされている形式 (C# の XML-docs など) でドキュメント化されている場合、すべてのドキュメントが適切な形式で表示されます。それ以外の場合は、基本的なシンボル情報が表示されます (完全なメソッドシグネチャーまたは型の可視性と名前空間など)。シンボルのクイックドキュメントを表示キャレットを配置するエディターのシンボル参照、ファイル構造ウィンドウまたはその他の ReSharper...

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

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