ReSharper 2019.2ヘルプ

注釈を使用してコードインスペクションを絞り込む

コード検査や他の多くのReSharperの機能は、課題を検出し、改善を提案し、他の方法であなたを手助けするために、言語構成の動作を知ることに主に依存しています。

しかし、この種の分析ではすべてを検出することはできません。例:メソッドが null を返さないように設計されており、そのクライアントがそれに応じて設計されている場合、誰かが nullを返すメソッドを変更した場合、構造分析によって課題が見つかることはありません。

これと他の多くのケースでは、ReSharperの JetBrains.Annotations は大きな助けになります。このフレームワークで宣言された属性を使用することで、ReSharperが必要な方法でコードを分析できるようになります。たとえば:

[NotNull] public object Foo() { return null; // Warning: Possible 'null' assignment }

これが最も単純な例ですが、さらに複雑な使用例を持つ有用な属性が他にもあります。これらの属性の完全なリストはリファレンスにあります。

ほとんどの場合、コード注釈属性は特定のコードインスペクションを有効にします。

また、コード注釈により、クイックフィックスコード補完の提案、および注釈付きアイテムのコード生成機能が可能になります。注釈はソース・テンプレートを作成して使用するためにも必要です。

ReSharperでは、コードシンボルに2つの方法で注釈を付けることができます。

  • 上記の例に示すように、ソースコードのシンボルに注釈を付けることができます。この場合、プロジェクト内の JetBrains.Annotations 名前空間を参照する必要があります。詳細は、ソースコードの注釈を参照してください。

  • ソースにアクセスできない場合でも、コンパイルされたライブラリーコードのシンボルに注釈を付けることができます。詳細は、外部注釈を参照してください。

この機能は、次の言語とテクノロジでサポートされています。

Language: C#Language: VB.NETLanguage: C++Language: HTMLLanguage: ASP.NETLanguage: RazorLanguage: JavaScriptLanguage: TypeScriptLanguage: CSSLanguage: XMLLanguage: XAMLLanguage: ResxLanguage: Build ScriptsLanguage: ProtobufLanguage: JSON
Feature is availableFeature is availableFeature is not availableFeature is not availableFeature is availableFeature is availableFeature is not availableFeature is not availableFeature is not availableFeature is not availableFeature is not availableFeature is not availableFeature is not availableFeature is not availableFeature is not available

C#の機能の使用方法については、こちらの説明と例を参照してください。他言語の詳細については、言語によるReSharperの対応するトピックを参照してください。

最終更新日: 2019年10月15日

関連ページ:

コード・インスペクション

ReSharperはサポートされているすべての言語で2500以上のインスペクションを提供します。これらのインスペクションは、開いているすべてのファイルで設計時にコードの課題を検出して強調表示するため、および/または特定の範囲内ですべてのコードの課題を見つけるために使用されます。インスペクション Re...

コード注釈属性

フレームワークは、以下で説明する多くの属性を提供します。これらの属性をコードで使用するには、ソースコードの注釈セクションの説明に従ってを参照する必要があります。注釈属性:CanBeNullAttributeマークされた要素の値がになることがあることを示します。そのため、使用前にのチェックが必要です。...

文字列リテラルのコード解析とヘルパー

ReSharperは、コード内の文字列リテラルに一連の機能を提供します: ReSharperのコード分析と多数のヘルパーの恩恵を受ける:平紐、文字列の書式設定メソッド、カスタム文字列書式設定メソッド、補間された文字列、平紐:コードにプレーンな文字列を使って作業しているときにReSharperがどの...

価値とnull可能性の分析

ReSharperは、可能な「null」逆参照、および重複ブール比較およびnull・チェックを見つけるのに役立つ値分析を実行します。値を分析するさまざまな方法:ReSharperは、2つの一般的な方法で値を分析します。言語構成の動作を理解することによって。以下の例では、パラメータがnull許容性を明...

契約の注釈

契約注釈では、与えられた入力に対する期待される出力を定義することができます。言い換えれば、関数の参照型とブール型引数とその戻り値の間の依存関係を定義することができます。契約注釈のメカニズムにより、より簡単で安全な方法で消費できるAPIを作成できます。場合によっては、契約注釈の代わりに簡単な代替案を使...

コードの課題のクイックフィックス

ReSharperを使用すると、設計時に検出されたほとんどのコード課題を即座に修復できます。強調表示されたコードの課題で を押して、課題を解決したり最適以下のコードを改善したりするための適切な方法を選択するのと同じくらい簡単です。クイックフィックスの適用:クイックフィックスは、強調表示されたコード...