File header style

Select ReSharper | Options from the main menu or press Alt+R O, then choose Code Editing | File Header Text on the left.

In the File Header Text area, insert an arbitrary text that you want to insert into your code files. You can also use macros that allow file headers to contain varying information. To use a macro, type it or click the corresponding macro, it will be inserted at the current caret position.

Optionally, to surround the file header with a region, enter the name of the region in the Embrace File Header into Region with Name field.

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.

Open the .editorconfig file where you want to configure file header, or create a new one.

Add the file_header_template property to the file, for example:

Create a new file template or edit en existing template where you want to add a file header.

In the beginning of the template add a template parameter and associate it with the 'File header' macro.

Save the template.

New files created with this template will have the specified file header.

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

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

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 Update file header checkbox. Optionally, you can enable other code cleanup tasks in this profile.

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.

Select the scope where you want to update file header:

• Set the caret anywhere in the file to update file header to the file.

• Select one or more items in the Solution Explorer to update file header in the files under these nodes and their child items.

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.

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

Click Run. ReSharper will update file header in the selected scope.

If you want to update file header 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 inserting file headers with other code style tasks.

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

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

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

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.

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.

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.