JetBrains Rider 2024.1 ヘルプ

コードの構文スタイル: 修飾子

型および型メンバーの C# 修飾子は、任意の順序で記述できます。ただし、コード全体で同様の方法で配置することは、コードの可読性を向上させるための良い方法です。また、privateinternal の修飾子を明示的に使用したり使用したりしたくない場合もあります。

JetBrains Rider を使用すると、既存のコードに修飾子を配置したり、コード補完とコード生成機能を使用して新しいコードを生成したり、コードテンプレートを適用したり、リファクタリングを実行したりするときに設定を考慮できます。

既存のコードに修飾子を配置する

デフォルトでは、JetBrains Rider は privateinternal 修飾子を明示的に使用し、修飾子を特定の順序で並べることを提案します。必要に応じて、これらの設定を柔軟に設定できます

コードがこれらの設定に準拠していない場合、JetBrains Rider はそのような宣言をハイライトして、対応するクイックフィックスを提案するか、修飾子の順序の範囲を修正します

Sorting modifiers

... private 修飾子の場合:

Fixing implicit private modifier

... と internal 修飾子の場合:

Fixing implicit internal modifier

バルクモードで修飾子のすべての設定を適用するもう 1 つのオプションは、コードのクリーンアップです。組み込みプロファイルフルクリーンアップまたは再フォーマットして構文スタイルを適用のいずれかを使用してコードクリーンアップ実行するか、以下で説明するように、特定のタスクのみを対象としたカスタムプロファイルを作成して実行できます。

コードのクリーンアップで修飾子の設定を適用する

  1. Ctrl+Alt+S を押すか、メニューからファイル | 設定(Windows および Linux)または JetBrains Rider | 環境設定 (macOS) を選択します。

  2. クリーンアッププロファイル設定ページに移動します: エディター | コードのクリーンアップ

  3. 新しいカスタムクリーンアッププロファイルを作成するセクションの説明に従って、新しいプロファイルを作成します。新しいプロファイルの選択したプロファイル設定セクションで、タイプに明示的 / 暗黙的修飾子を使用する型メンバーに明示的 / 暗黙的修飾子を使用する修飾子の並べ替えチェックボックスをオンにします。

  4. 設定ダイアログで保存をクリックして変更を適用し、JetBrains Rider が変更を保存する場所を選択できるようにするか、保存セレクターからこのレイヤーを選択して特定の設定レイヤーに変更を保存します。詳細については、「レイヤーベースの設定」を参照してください。

  5. 設定を適用する範囲を選択します。

    • ファイル内の任意の場所にキャレットを配置して、ファイルに設定を適用します。

    • ソリューションエクスプローラー内の 1 つまたは複数の項目を選択して、これらのノードおよびその子項目にあるファイルに設定を適用します。

  6. Ctrl+R, C を押すか、メインメニューからコード | 再フォーマットとクリーンアップ…を選択します。

  7. 開いたコードの再フォーマットとクリーンアップダイアログで、新しく作成したプロファイルを選択し、必要に応じて別のスコープを選択します。

  8. OK をクリックします。JetBrains Rider は選択した範囲内であなたの設定を強制します。

Reformat and Cleanup Code ダイアログを開いてプロファイルを選択せずに修飾子を配置する場合は、作成したプロファイルをサイレントクリーンアップにバインドし、Ctrl+R, G を押して実行できます。修飾子スタイルの適用と他のコードスタイルタスクを組み合わせたカスタムクリーンアッププロファイルを作成することもできます。

選択したコードブロック Alt+Enter に、他のすべてのフォーマットおよび構文スタイルの規則とともに修飾子の設定を適用するには、再フォーマットとクリーンアップ | 構文スタイルを再フォーマットして適用するを選択します。

最近変更して Git にコミットする予定のコードに修飾子を配置できます。JetBrains Rider は、コミットする前に、選択したクリーンアッププロファイルを実行します。

Git にコミットする前にコードをクリーンアップする

  1. Ctrl+K を押すか、メインメニューから Git | コミットを選択します。

  2. コミットツールウィンドウで Show Commit Options をクリックし、コミットチェック領域でクリーンアップ ... チェックボックスを選択します。

  3. プロファイルの選択をクリックして、カスタムコードクリーンアッププロファイルを選択します。

  4. コミットまたはコミットとプッシュをクリックします。JetBrains Rider は、コミット用にステージングされたファイルでコードのクリーンアップを実行し、変更をコミットします。

変更をファイルに保存するたびに修飾子を配置して、編集が常にコードスタイルに準拠するようにすることができます。これは、変更を Ctrl+S または Ctrl+S で明示的に保存した場合にのみ発生し、auto-saving によってトリガーされないことに注意してください。ただし、自動保存されたすべてのファイルは「再フォーマットおよびクリーンアップ」キューに配置され、次の明示的な保存で処理されます。

変更を保存するときに修飾子を自動的に配置する

  1. Ctrl+Alt+S を押して設定を開き、ツール | 保存時のアクションを選択します。

  2. コードの再フォーマットとクリーンアップを選択し、カスタムコードクリーンアッププロファイルを選択して、それをファイル全体に適用するか、変更された行のみに適用するかを選択します。

  3. 次に編集を終了してファイルまたはすべてのファイルを保存すると、JetBrains Rider は選択されたプロファイルを使用して影響を受けるファイルをクリーンアップします。

修飾子の設定を構成する

修飾子関連の設定は、レイヤーベースの設定のメカニズムを使用して保存されます。とりわけ、このメカニズムにより、さまざまなソリューションのさまざまな設定を維持したり、これらの設定を VCS に保持したり、チームメンバーと自動的に共有することができます。

修飾子の設定を構成する

  1. JetBrains Rider 設定 Ctrl+Alt+Sエディター | コードスタイル | C# ページに移動し、構文スタイルタブを選択します。

  2. 修飾子カテゴリでは、修飾子の順序を指定し、private 修飾子と internal 修飾子を明示的に使用するための設定を行います。

  3. 右側の列のセレクターを使用すると、設定とは異なるコードインスペクション検出コードの重大度レベルを設定できます。

  4. 設定ダイアログで保存をクリックして変更を適用し、JetBrains Rider が変更を保存する場所を選択できるようにするか、保存セレクターからこのレイヤーを選択して特定の設定レイヤーに変更を保存します。詳細については、「レイヤーベースの設定」を参照してください。

privateinternal 修飾子の明示的 / 暗黙的な使用のための設定をエディターで変更することもできます。対応する問題がハイライトされます:

エディターで修飾子の設定を変更する

  1. JetBrains Rider のインスペクションでハイライトされているコードの問題にキャレットを置きます。

  2. Alt+Enter を押すか、キャレットの左側にあるアクションインジケーターをクリックして、アクションリストを開きます。

  3. アクションリストで、インスペクション " 型に明示的または暗黙的な修飾子定義を使用する " | 暗黙の「内部」修飾子を優先しますを選択します。

    Changing the preference for explicit/implicit 'internal' modifier in the editor
  4. 変更は、スマートセーブロジックを使用して保存されます。

  5. 変更したスタイル設定を共有設定レイヤーに保存する必要がある場合は、コードスタイルを設定するメニュー項目をクリックするか、選択時に Enter を押します。JetBrains Rider により、JetBrains Rider 設定のエディター | コードスタイル | C# | 構文スタイルページが開きます。必要に応じて設定を変更し、保存先をクリックして、目的の設定レイヤーを選択します。

  6. 同様に、明示的 / 暗黙的な private 修飾子の設定を変更することができます。

    Changing the preference for explicit/implicit 'private' modifiers in the editor

関連ページ:

フィールドを読み取り専用にする

宣言またはコンストラクター内で割り当てられ、読み取り使用箇所のみを持つフィールドには、'readonly' 修飾子を使用するのが妥当なことがよくあります。デフォルトでは、JetBrains Rider は上記の条件が満たされた場合にフィールドを読み取り専用にすることを提案します。それはそのようなフィールドを強調して、対応するクイックフィックスを提案するか、範囲を修正します:JetBrains Rider がこれを提案したくない場合は、それを検出するコードインスペクション(フィールドは読み取り専用...

コード補完 (IntelliSense)

JetBrains Rider のコード補完機能に慣れ親しむために、実装の基礎をいくつか紹介します。新しい識別子の入力を開始するとすぐに、自動補完の候補リストが表示されます。を押すと、基本補完の候補リストが表示されます。他の 2 つの補完コマンド、型一致補完および第 2 基本補完は、高度なアルゴリズムを適用して、候補リストにさらに項目を追加します。AI Assistant を有効にしている場合は、周囲のコンテキストに基づいてコードブロック全体を作成できる AI を搭載したコード補完を利用できます。...

コード生成

JetBrains Rider は、定型コードを生成するさまざまな方法を提供します。例: 宣言されていないコードシンボルを使用し、これらのシンボルを用途に基づいて自動的に生成したり、型メンバーを生成したりすることができます。現在のファイルで設計時コードインスペクションが有効になっている場合、JetBrains Rider は足りないメンバーを検出し、足りないメンバーを実装するために対応するクイックフィックスを提案します。コンテキストアクションとコードテンプレートを使用すると、コードを生成するその...

設計時にコードの問題を分析する

JetBrains Rider は、エディターでコードファイルを開くとすぐに、コードファイルが閉じられるまで分析を開始します。検出されたすべてのコードの問題は、重大度に応じてエディターでハイライトされます。問題のマップは、エディターウィンドウの右側のエラーストライプにも表示されます。ここでは、ファイルのステータスを即座に確認し、マークをクリックして特定のコードの問題に移動できます。デザインタイムインスペクションの機能:デザイン時のインスペクション機能は、Rider エディターの基本機能への主要...

スコープを修正

ほとんどのクイックフィックスは、キャレットで現在の問題を修正できますが、中には (たとえば、未使用のディレクティブを削除する、フィールドを読み取り専用にする、冗長なキャストの除去など)、現在のファイル、現在のプロジェクト、ソリューション全体など、より大きな範囲で問題を自動的に見つけて修正できるものもあります。範囲内の修正を適用する:このような修正は、アクションリストの横に表示される小さな矢印で識別できます。範囲内の修正を適用する JetBrains Rider のインスペクションでハイライトされ...

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

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