ReSharper 2021.3 Help

Code syntax style: file-scoped namespaces

Starting from C# 10, you can use file-scoped namespace declarations in files containing a single namespace.

If you prefer to stick to either file-scoped or block-scoped namespace declarations, ReSharper lets you configure your preferences and maintain the consistency of your preferences throughout your codebase.

ReSharper helps you enforce preferences for file-scoped namespaces in the existing code and takes your preferences into account when it produces new code with code completion and code generation features, applies code templates and performs refactorings.

Enforce preferences for file-scoped namespaces

ReSharper can help you check single namespaces in your files for compliance with your preferences and if they do not comply, it highlights such declarations and suggests the corresponding quick-fix or fix in scope. Default ReSharper's preferences say that file-scoped namespaces are preferred:

ReSharper: 'To file-scoped namespace' quick-fix

However, you can configure your preferences in a different way, so that ReSharper suggests making existing file-scoped namespaces block-scoped:

ReSharper. 'To block-scoped namespace' quick-fix

Another option to enforce preferences for file-scoped namespaces in a bulk mode is code cleanup. You can either run code cleanup with one of the built-in profiles Full Cleanup or Reformat & Apply Syntax Style, or create and run a custom profile solely targeted at your specific task as described below.

Apply preferences for file-scoped namespaces with custom Code Cleanup profile

  1. Select ReSharper | Options from the main menu or press Alt+R O.

  2. Go to the cleanup profiles settings page: Code Editing | Code Cleanup | Profiles.

  3. Create a new profile as described in the Create a new custom cleanup profile section. In the Selected profile settings section for the new profile, tick the Arrange namespaces (file-scoped vs. block-scoped checkbox. Optionally, you can enable other code cleanup tasks in this profile.

  4. Click Save in the Options dialog to apply the modifications and let ReSharper choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see manage and share resharper settings.

  5. Select the scope where you want to enforce your preferences:

    • Set the caret anywhere in the file to enforce your preferences to the file.

    • Select one or more items in the Solution Explorer to enforce your preferences in the files under these nodes and their child items.

  6. Do one of the following:

    • Press Control+Alt+F or choose ReSharper | Edit | Cleanup Code... from the main menu .

    • Right-click anywhere in the text editor or right-click the selection and choose Cleanup Code in the context menu.

  7. In the Code Cleanup dialog that opens, select the newly created profile .

  8. Click Run. ReSharper will enforce your preferences in the selected scope.

If you want to enforce preferences for file-scoped namespaces without opening the Code Cleanup dialog to choose a profile, you can bind the created profile to the silent cleanup and run it by pressing Control+Shift+Alt+F. You can also create a custom cleanup profile that would combine applying the preferences with other code style tasks.

You can enforce preferences for file-scoped namespaces every time you save changes in a file to make sure that your edits always comply with your code style.

Automatically enforce preferences for file-scoped namespaces on saving changes

  1. Select ReSharper | Options from the main menu or press Alt+R O.

  2. Go to the cleanup profiles settings page: Code Editing | Code Cleanup | Profiles.

  3. Select your custom Code Cleanup profile and click Set as default (the default profile is also used for silent cleanup).

  4. Go to the Code Editing | Code Cleanup | General options page and select Automatically run cleanup when saving a file.

    Optionally, you can restrict automatic cleanup to specific files by a file mask. You can also select Only changed parts of file to make sure that cleanup is applied to the code affected by your changes, and the rest of the code in the file is not modified.

  5. Click Save in the dialog to apply the modifications and let ReSharper choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see manage and share resharper settings.

  6. The next time you finish editing and save the file (Ctrl+S) or all files (Ctrl+Shift+S) , ReSharper will clean up the affected files using the selected profile. If the default cleanup profile is not selected, ReSharper will prompt you choose one of the profiles.

Configure preferences for file-scoped namespaces

Your namespace declaration style preferences are saved using the mechanism of layer-based settings. Among other things, this mechanism allows you to maintain different preferences for different solutions as well as to keep these preferences under a VCS and automatically share them with your team members.

Configure namespace declaration style in options

  1. Go to the Code Editing | C# | Syntax Style page of ReSharper options (Alt+R, O) .

  2. Find the Namespaces option under Code body and choose File-scoped or Block-scoped.

  3. The Notify with selectors in the right column allow you to set severity levels of code inspections detecting code that differs from your preferences.

  4. Click Save in the Options dialog to apply the modifications and let ReSharper choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see manage and share resharper settings.

You can also change your preferences for namespace declarations right in the editor, where a corresponding issue is highlighted:

Change preference for namespace declaration style from the editor

  1. Set the caret to a code issue highlighted by a ReSharper's inspection.

  2. Press Alt+Enter or click the action indicator to the left of the caret to open the action list.

  3. In the action list, choose Inspection "Use preferred namespace body style..." | Configure code style and then select a desired preference:

    ReSharper: Changing code style preference for namespace body
  4. Your change will be saved using the smart save logic.

  5. If you need to save the modified style preference in a shared settings layer, click the Configure code style menu item or press Enter when it is selected. ReSharper will open the Code Editing | C# | Syntax Style page of ReSharper options where you can modify your preference as needed, click Save To and then choose the desired settings layer.

This feature is supported in the following languages and technologies:

Language: C#

Language: VB.NET

Language: C++

Language: HTML

Language: ASP.NET

Language: Razor

Language: JavaScript

Language: TypeScript

Language: CSS

Language: XML

Language: XAML

Language: Resx

Language: Build Scripts

Language: Protobuf

Language: JSON

Feature is available in C#

Feature is not available in Visual Basic .NET

Feature is not available in C++

Feature is not available in HTML

Feature is not available in ASP.NET

Feature is not available in Razor

Feature is not available in JavaScript

Feature is not available in TypeScript

Feature is not available in CSS

Feature is not available in XML

Feature is not available in XAML

Feature is not available in Resource files

Feature is not available in build script files

Feature is not available in Protobuf

Feature is not available in JSON

Last modified: 18 November 2021