構文スタイル
コードスタイルの側面の 1 つは、互換性のある言語構文構造を使用する方法です。 例: 以下の 2 つのメソッド定義は、コンパイラーの観点からは同じですが、構文構造の選択により、それらは異なって見えます。
[Conditional("DEBUG")]
[Test]
static public void Foo(String str)
{
foreach (Char ch in str)
{
System.Console.WriteLine(value: ch);
}
}
|
[Test, Conditional("DEBUG")]
public static void Foo(string str)
{
foreach (var ch in str)
Console.WriteLine(ch);
}
|
コード構文スタイルを構成する
ReSharper の使用を開始すると、デフォルト設定が参照され、コードベース全体で交換可能な構文構造が一貫して利用されるようになります。 ただし、それぞれの好みを好みに合わせて設定することができます。 コード構文スタイルを設定する方法は 2 つあります。
ReSharper オプション の ページで環境設定を構成してください Alt+R、O 。 これらの変更は 階層化設定のメカニズムを使用して保存されるため、すべてのプロジェクトのローカルマシンに適用したり、チームメイトと共有したりできます。
ReSharper 独自の EditorConfig コードスタイルプロパティを使用して EditorConfig ファイル内で環境設定を指定できます。これにより、チーム全体で一貫したコードスタイルを維持できます。
.editorconfig ファイルで指定された環境設定は、ReSharper 設定に保存された環境設定を オーバーライドする点にご注意ください。
選択したコードのコード構文スタイルルールを構成する
設定ページを掘り下げる代わりに、コードのブロックを選択し、そのブロックに適用できるコード構文スタイルのルールのみを構成できます。 変更された設定が、エディターで選択したブロックのコードにどのように影響するかを確認できます。
エディターで、構文スタイルをコーディングするコードのブロックを選択します。
Alt+Enter を押して、 を選択します。
開いたダイアログに、選択したコードブロックに影響を与えるすべての構文スタイルとフォーマット規則が表示されます。 コードブロック自体は点線のフレームで囲まれます。
コード構文スタイルルールを変更すると、それらが選択したブロックのコードにどのように影響するかがわかります。
ダイアログで 保存 をクリックして変更を適用し、ReSharper に保存場所を任せるか、 保存先 セレクターから特定の設定レイヤーを選択して変更を保存します。 詳細については、 resharper 設定の管理と共有 をご参照ください。
保存先 セレクターで .editorconfig を選択して、 構成されたコード構文スタイルルールを EditorConfig にエクスポートすることも選択できることに注意してください。
必要に応じて、 コメントとして保存 をクリックします。 こうすることで、変更内容は選択したブロックの前後に コメントとして保存されます。 これにより、設定を変更せずに、必要なコード構文スタイルのルールをローカルでオーバーライドできます。
ReSharper はダイアログを閉じ、変更されたコード構文スタイルルールをコードブロックに適用します。
既存のコードからコード構文スタイルのルールを学ぶ
個別のコード構文スタイルの環境設定を調整する代わりに、既存のコードサンプルから構文スタイルルールを学習するという方法もあります。コードサンプルには、選択したブロック、現在のファイル、ファイルのセット、1つ以上のプロジェクト、またはソリューション全体が利用できます。 ReSharper は選択したサンプルを分析し、現在の設定と異なるコード構文スタイルルールを一覧表示します。 その後、検出されたルールを確認し、必要に応じて変更し、 設定レイヤー または .editorconfig や .clang-format 構成ファイルに保存できます。
コード構文スタイル設定を分析するスコープを選択します。
エディターで選択を行い、選択範囲のコード構文スタイル設定を分析します。
ファイル内のコード構文スタイル設定を分析するには、ファイル内の任意の場所にキャレットを配置します。
次のいずれかを実行します。
メインメニューから を選択します。
コードサンプルが選択項目の場合は、 Alt+Enter を押して を選択します。
現在の設定と異なる規則を確認してください。
ダイアログで 保存 をクリックして変更を適用し、ReSharper に保存場所を任せるか、 保存先 セレクターから特定の設定レイヤーを選択して変更を保存します。 詳細については、 resharper 設定の管理と共有 をご参照ください。
コードサンプルが選択されている場合は、必要に応じて コメントとして保存 をクリックします。 こうすることで、変更内容は選択したブロックの前後に コメントとして保存されます。 これにより、設定を変更せずに、必要なコード構文スタイルのルールをローカルでオーバーライドできます。
コードインスペクションを使用してコード構文スタイルを確認および修正する
ReSharper は、コードがコード構文スタイルに準拠しているかをチェックする複数の コードインスペクションを提供し、違反箇所に対しては クイックフィックスを提案します。例えば、 修飾子の順序が環境設定と異なる場合などです：
ソリューション全体に至るまで、目的のスコープ内のすべてのコード構文スタイルの問題を確認する必要がある場合は、このスコープで コードインスペクションを実行できます。 分析が終了したら、問題のカテゴリごとに結果をグループ化し、問題の場所と場所を確認します。
すべてのコード構文スタイルインスペクションは構成可能であり、不要なものを 無効にすることができます。
コード構文スタイルインスペクションのリストを調べて、それらすべてを一度に構成することもできます。 これを行うには 2 つの方法があります。
ReSharper オプション の ページで、右側の列にあるセレクターを使い、無効化したいインスペクションには 表示しない を選択してください Alt+R、O 。
このオプションページでは、各コード構文スタイルルールの設定を変更することもできます。
ReSharper オプション の ページで、 グループ内のコード構文スタイルインスペクションを見つけ、無効化したいものの隣にあるチェックボックスをオフにしてください Alt+R、O 。
コードのクリーンアップでコード構文スタイルを適用する
目的のスコープにコード構文スタイルを適用するには、 コードクリーンアップを使用することもできます。 組み込みプロファイルの フルクリーンアップ または 再フォーマットして構文スタイルを適用 のいずれかで コードのクリーンアップ を実行するか、または希望するコード構文スタイルルールのサブセットで カスタムプロファイル を作成して実行することができます。
C# および C++ のコード構文スタイルの追加アクション
C# では、ReSharper はコード構文スタイルを適用するための専用アクション Control+Alt+S （ ）を提供します。
C# コード構文スタイルを既存のコードに適用する
構文スタイル設定を適用するスコープを選択します。
エディターで選択を行い、選択に構文スタイルの設定を適用します。
ファイル内の任意の場所にキャレットを配置して、ファイル内の構文スタイル設定を適用します。
ソリューションエクスプローラー で 1 つ以上のアイテムを選択して、これらのアイテムとその子アイテムのファイルに構文スタイルの設定を適用します。
Control+Alt+S を押すか、メインメニューから を選択してください。 あるいは、 Control+Shift+A を押して、ポップアップでコマンド名を入力して、そこで選択することもできます。
現在の選択範囲に対応するコンテキストアクションを使用して、コード構文スタイルを適用することもできます。
現在の選択にコード構文スタイルを適用する
エディターで、コード構文スタイルを適用するコードブロックを選択します。
Alt+Enter を押して、 を選択します。
異なる言語での適用性
ReSharper のほとんどのコード構文スタイル機能は C# と Visual Basic で利用でき、一部は複数の言語に対応し、その他は特定の言語専用です。 下記の表では、すべてのコード構文スタイル機能と、それがサポートされる言語・テクノロジーを一覧しています。
このセクション内のトピックに示されている手順と例では、C# のコード構文スタイル機能の使用について説明します。 特定の言語で使用できるコード構文スタイル機能の詳細については、 言語およびフレームワーク セクションの対応するトピックを参照してください。
