ツイートシェアはてブ LINE Pocket

コード検査: パラメーター出力値は常に破棄されます (非公開アクセシビリティ)

C# 6.0 の「out var」は、out パラメーターを持つメソッドを使用するために必要なコードの量を大幅に削減します。現在では、ほとんどの場合、変数をインラインで宣言し、変数の型を省略するために型推論を使用することがよくあります: dictionary.TryGetValue(key, out var value).

C# 6.0 が改善した out パラメーターの別の側面は、M(out _) または M(out var _) 構文では不要な出力パラメーター値を無視する機能です。最新の C# コードベースで DoSomething(arg, out _, out _) のような呼び出しが見られることは珍しくありません。

JetBrains Rider は、そのような呼び出しを分析し、すべての呼び出しサイトで破棄される out パラメーターを報告します。これは、値が常に破棄される潜在的な問題を特定し、未使用のパラメーターを削除することで署名を簡素化できます。

  class SetOfThings
  {
    private Dictionary<string, int> _set = new();

    // Parameter 'value' output value is always discarded
    public bool HasKey(string key, out int value)
    {
      return _set.TryGetValue(key, out value);
    }
  }

  class Test
  {
    public void Usage(SetOfThings set)
    {
      if (set.HasKey("abc", out _))
        Console.WriteLine("do something");
    }
  }

        

  class SetOfThings
  {
    private Dictionary<string, int> _set = new();

    public bool HasKey(string key)
    {
      int value;
      return _set.TryGetValue(key, out value);
    }
  }

  class Test
  {
    public void Usage(SetOfThings set)
    {
      if (set.HasKey("abc"))
        Console.WriteLine("do something");
    }
  }

        

ソリューション全体のインスペクションを機能させるには、次の少なくとも 1 つを有効にする必要があります。

簡略化されたグローバル使用状況チェック: JetBrains Rider 設定 Ctrl+Alt+S のエディター | インスペクション設定ページでソリューション全体の分析がオフの場合に、未使用の非プライベートタイプメンバーを表示するを選択します。
ソリューション全体の分析 : JetBrains Rider 設定 Ctrl+Alt+S のエディター | インスペクション設定ページでソリューション全体の分析を可能にするを選択します。

報告されたパラメーターがソリューション内で直接使用されていない場合でも、リフレクションなどによって間接的に使用される場合や、単にパブリック API として設計されている場合もあります。これらのすべてのケースでは、次のいずれかの方法で、パラメーターの使用状況チェックインスペクションを抑制する必要があります。

推奨される方法は、暗黙的に使用されるパラメーターをコードアノテーション属性で装飾することです。この目的には 2 つの属性があります。[UsedImplicitly] と [PublicAPI] です。これらは機能的には似ていますが、パラメーターが実際にどのように使用されるかをチームメートに理解させます。
また、カスタム属性を使用してインスペクションの使用状況を抑制することもできます。これを行うには、その属性の定義に [MeansImplicitUse] 属性を付けます。
そして最後に、特定の使用チェックインスペクションを、抑制コメントまたは抑制属性を持つ他のコードインスペクションと同様に抑制することができます。

最終更新日: 2024 年 5 月 26 日

関連ページ：

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

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

ソリューション全体の分析

JetBrains Rider のソリューション全体の分析により、2 つの関連しているが異なる機能が実現します。ソリューション全体のエラー / 警告モニター:JetBrains Rider 自身のインスペクションによって検出されたコンパイラーのエラー / 警告とエラー / 警告の両方で、ソリューション内のすべてのエラー / 警告を常に追跡できます。この機能は設計時コードインスペクションと連携して 2 つの利点をもたらします。ソリューションにエラー / 警告が含まれていないことを確認するために、す...

アノテーションを使用してコードインスペクションを改善する

コード検査などの JetBrains Rider の多くの機能は、問題を検出し、改善を提案し、他の方法でお手伝いするために、言語構成の動作を知ることに大きく依存しています。ただし、この種の分析ではすべてを検出できるわけではありません。例: メソッドがフォーマットメソッドとして設計されている場合、メソッドの呼び出しに必要な引数が含まれていない場合、構造解析では潜在的な問題は見つかりません。この場合や他の多くの場合、JetBrains Rider のは非常に役立ちます。このフレームワークで宣言された...