File header style

Configure file header in ReSharper options

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

2. In the File header text tab, type the text that you want to insert at the beginning of your source files.

   You do not have to include comment delimiters in the file header text. ReSharper will automatically insert proper delimiters for the specific language when the header template is applied.

3. To add variable information, such as date, time, or contributor name, use corresponding macros. The list of available macros is shown in the right part. To use a macro, type it in the header body or click the corresponding macro in the right part to insert it at the current caret position.

   In the File header variables tab, you can specify constant values to be reused in the header text. For example, you can add a variable with the name companyName and the value My company, and then use it in the header template as $Variable.Named(${myCompany}).

4. When applying file header template, by default ReSharper will automatically detect initial comments in the file, if any, as an existing file header and replace them with the specified file header.

   If you want to restrict this behavior and only consider specific comments as file headers, edit the regular expression in the File header start detection regex field. For example, you can change it to Copyright .* to match only initial comments starting with Copyright.

   If you want to reuse the existing header that was matched by the regular expression, add the ${OldHeader.Text} macro in the desired position within the file header template.

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

6. 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 by choosing this layer from the Save To selector. For more information, see manage and share resharper settings.

Configure file header via EditorConfig

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

2. Add the file_header_template property to the file, for example:

   file_header_template=Your Company. \nSome info about {fileName}

Add file header to newly created files

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

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

   

3. Save the template.

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

Insert file header into existing files with Code Cleanup

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 Update file header 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 by choosing this layer from the Save To selector. For more information, see manage and share resharper settings.

5. Select the scope where you want to update file header:

   • Place 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.

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 update file header in the selected scope.

9. 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.

Automatically update file header 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.

   If you choose to clean up only the changed parts of files, you can fine-tune this behavior with the following options:

   • Perform full cleanup if partial cleanup is not possible — depending on this option, ReSharper will either clean up the whole file or skip the file if it is not possible to restrict the cleanup to the modified parts of the file.

   • Allow cleanup on save for shared files — use this option to enable or disable partial cleanup in files that are included in the solution several times, such as files from shared projects.

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 by choosing this layer from the Save To selector. 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 to choose one of the profiles.

Share file header style within a team

• If you are configuring file header via .editorconfig, make sure that the corresponding .editorconfig file is added to a version control system.

• If you are configuring file header via ReSharper options, save your configuration changes to the 'Solution team-shared' settings layer: after making the desired changes, choose Solution 'solutionName' team-shared in the Save To selector in the Options dialog.

  Make sure that the <SolutionName>.sln.DotSettings file is added to a version control system.