コードのスタイル設定Code style preferences

EditorConfig ファイルを使用し、プロジェクト別にコード スタイル設定を定義できます。あるいは、テキスト エディターの [オプション] ページで、Visual Studio で編集するすべてのコードを対象にできます。You can define code style settings per-project by using an EditorConfig file, or for all code you edit in Visual Studio on the text editor Options page. C# コードの場合、コードのクリーンアップ (Visual Studio 2019) コマンドとドキュメントのフォーマット (Visual Studio 2017) コマンドを使用し、これらのコード スタイル設定を適用するように Visual Studio を構成することもできます。For C# code, you can also configure Visual Studio to apply these code style preferences using the Code Cleanup (Visual Studio 2019) and Format Document (Visual Studio 2017) commands.

Note

このトピックは、Windows 上の Visual Studio に適用されます。This topic applies to Visual Studio on Windows. Visual Studio for Mac については、Visual Studio for Mac でのエディターの動作に関するページを参照してください。For Visual Studio for Mac, see Editor behavior in Visual Studio for Mac.

EditorConfig ファイルのコード スタイルCode styles in EditorConfig files

.NET に対するコード スタイルの設定は、EditorConfig ファイルをプロジェクトに追加することで指定できます。Code style settings for .NET can be specified by adding an EditorConfig file to your project. EditorConfig ファイルは、Visual Studio のパーソナル化アカウントではなく、コードベースに関連付けられます。EditorConfig files are associated with a codebase rather than a Visual Studio personalization account. EditorConfig ファイル内の設定は、 [オプション] ダイアログ ボックスで指定されているコード スタイルよりも優先されます。Settings in an EditorConfig file take precedence over code styles that are specified in the Options dialog box. リポジトリまたはプロジェクトに対するすべての共同作成者にコーディング スタイルを適用する場合は、EditorConfig ファイルを使用します。Use an EditorConfig file when you want to enforce coding styles for all contributors to your repo or project.

EditorConfig ファイルは手動で入力できます。または、Visual Studio の [オプション] ダイアログ ボックスで設定したコード スタイルの設定に基づいて、ファイルを自動的に生成できます。You can manually populate your EditorConfig file, or you can automatically generate the file based on the code style settings you've chosen in the Visual Studio Options dialog box. このオプション ページは、 [ツール][オプション][テキスト エディター][C#] または [Basic][コード スタイル][全般] の順に選択すると表示されます。This options page is available at Tools > Options > Text Editor > [C# or Basic] > Code Style > General. [Generate .editorconfig file from settings](設定から .editorconfig ファイルを生成する) をクリックすると、この [オプション] ページの設定に基づいてコーディング スタイルの .editorconfig ファイルが自動的に生成されます。Click Generate .editorconfig file from settings to automatically generate a coding style .editorconfig file based on the settings on this Options page.

Visual Studio 2019 で設定から editorconfig ファイルを生成する

[オプション] ダイアログ ボックスのコード スタイルCode styles in the Options dialog box

すべての C# プロジェクトと Visual Basic プロジェクトに対してコードのスタイルを設定するには、 [ツール] メニューから [オプション] ダイアログ ボックスを開きます。Code style preferences can be set for all of your C# and Visual Basic projects by opening the Options dialog box from the Tools menu. [オプション] ダイアログ ボックスで、 [テキスト エディター] > [C#] または [Basic] > [コード スタイル] > [全般] の順に選択します。In the Options dialog box, select Text Editor > [C# or Basic] > Code Style > General.

選択すると、リスト内の各項目について優先順位のプレビューが表示されます。Each item in the list shows a preview of the preference when selected:

コード スタイルのオプション

コード スタイルのオプション

このウィンドウで設定したオプションは、Visual Studio のパーソナル化アカウントに適用され、特定のプロジェクトまたはコードベースには関連付けられません。Options set in this window are applicable to your Visual Studio personalization account and aren't associated with a particular project or codebase. さらに、継続的インテグレーション (CI) のビルドなど、ビルド時には適用されません。In addition, they aren't enforced at build time, including in continuous integration (CI) builds. コード スタイルのユーザー設定をプロジェクトに関連付けて、ビルド時にスタイルを適用する場合は、プロジェクトに関連付けられている .editorconfig ファイルでユーザー設定を指定します。If you want to associate code style preferences with your project and have the styles enforced during build, specify the preferences in an .editorconfig file that's associated with the project.

優先順位と重大度Preference and severity

各行のドロップダウンを使用して、このページのコード スタイル設定ごとに [優先順位][重大度レベル] の値を設定できます。For each code style setting on this page, you can set the Preference and Severity values using the drop-downs on each line. 重大度は、 [リファクタリングのみ][提案][警告] 、または [エラー] に設定できます。Severity can be set to Refactoring Only, Suggestion, Warning, or Error. コード スタイルのクイック アクションを有効にする場合、 [重大度レベル] の設定は確実に [リファクタリングのみ] 以外に設定してください。If you want to enable Quick Actions for a code style, ensure that the Severity setting is set to something other than Refactoring Only. クイック アクションの電球 電球、エラー電球 エラー電球、ねじ回し ねじ回し アイコンは、優先されていないスタイルが使用されていて、 [クイック アクション] 一覧のオプションを選ぶと優先されるスタイルにコードが自動的に再作成されると表示されます。The Quick Actions light bulb light bulb, error light bulb error light bulb, or screwdriver screwdriver icon appears when a non-preferred style is used, and you can choose an option on the Quick Actions list to automatically rewrite code to the preferred style.

コード スタイルの適用Apply code styles

正規の書式設定 (字下げなど) に沿って (EditorConfig ファイルまたは [コード スタイル] オプションから) コード スタイル設定を適用するようにドキュメントのフォーマット コマンドを構成できます ( [編集][詳細][ドキュメントのフォーマット] )。You can configure the Format Document command (Edit > Advanced > Format Document) to apply your code style settings (from an EditorConfig file or Code Style options) along with the regular formatting that it does (such as indentation). プロジェクトに .editorconfig ファイルが存在する場合、その設定が優先されます。If an .editorconfig file exists for the project, those settings take precedence.

Note

ドキュメントのフォーマット コマンドでコード スタイルを適用することは、C# コード ファイルの場合にのみ可能です。Applying code styles by using the Format Document command is only available for C# code files. これは試験段階の機能です。This is an experimental feature.

[書式設定] オプション ページドキュメントのフォーマットに適用する設定を構成します。Configure which settings you want Format Document to apply on the Formatting options page.

Visual Studio 2017 のドキュメントのフォーマットのコード スタイル設定

Tip

重大度がなしで構成されているルールは、コードのクリーンアップには関係しませんが、 [クイック アクションとリファクタリング] メニューを使用して個別に適用できます。Rules configured with a severity of None don't participate in code cleanup but can be individually applied via the Quick Actions and Refactorings menu.

初めて [ドキュメントのフォーマット] コマンドをトリガーするときに、黄色の情報バーが表示され、コードのクリーンアップ設定を構成するように求められます。The first time you trigger the Format Document command, a yellow info bar prompts you to configure your code cleanup settings.

C# コード ファイルの場合、Visual Studio 2019 では、エディターの一番下に [コードのクリーンアップ] ボタンがあり (キーボード:Ctrl+KCtrl+E)、これで EditorConfig ファイルまたは [コード スタイル] オプション ページからのコード スタイルを適用します。For C# code files, Visual Studio 2019 has a Code Cleanup button at the bottom of the editor (keyboard: Ctrl+K, Ctrl+E) to apply code styles from an EditorConfig file or from the Code Style options page. プロジェクトに .editorconfig ファイルが存在する場合、それが優先設定となります。If an .editorconfig file exists for the project, those are the settings that take precedence.

Visual Studio 2019 でコードのクリーンアップを実行する

Tip

重大度がなしで構成されているルールは、コードのクリーンアップには関係しませんが、 [クイック アクションとリファクタリング] メニューを使用して個別に適用できます。Rules configured with a severity of None don't participate in code cleanup but can be individually applied via the Quick Actions and Refactorings menu.

まず、 [コード クリーンアップの構成] ダイアログ ボックスで (2 つのプロファイルのいずれかで) 適用するコード スタイルを構成します。First, configure which code styles you want to apply (in one of two profiles) in the Configure Code Cleanup dialog box. このダイアログ ボックスを開くには、コードのクリーンアップのほうきアイコンの横にある展開用の矢印をクリックし、 [コード クリーンアップの構成] を選択します。To open this dialog box, click the expander arrow next to the code cleanup broom icon and then choose Configure Code Cleanup.

Visual Studio 2019 のコード クリーンアップの構成

コードのクリーンアップを構成した後、ほうきアイコンをクリックするか、または Ctrl + K キー、Ctrl + E キーを順に押して、コードのクリーンアップを実行します。After you've configured code cleanup, you can either click on the broom icon or press Ctrl+K, Ctrl+E to run code cleanup. プロジェクト全体またはソリューション全体に対して、コードのクリーンアップを実行することもできます。You can also run code cleanup across your entire project or solution. ソリューション エクスプローラーでプロジェクトまたはソリューションの名前を右クリックし、 [分析とコードのクリーンアップ] を選択して、 [コードのクリーンアップの実行] を選択します。Right-click on the project or solution name in Solution Explorer, select Analyze and Code Cleanup, and then select Run Code Cleanup.

プロジェクト全体またはソリューション全体に対してコードのクリーンアップを実行する

ファイルを保存するたびにコード スタイル設定を適用する場合、Code Cleanup on Save という拡張機能をお勧めします。If you want your code style settings to be applied every time you save a file, you may like the Code Cleanup on Save extension.

関連項目See also