ReSharper 2021.2 Help

File header style

Using file headers for copyright notices and other identifying messages is a common practice. ReSharper allows you to configure the default header text and automatically insert it into code files of your solution.

You can configure file header either in ReSharper options or in .editorconfig files and then add it to new files created with file templates and insert it to existing files using code cleanup.

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

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

  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.

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

    ReSharper: File template with file header
  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 using the Save To list. For more information, see Manage and share ReSharper settings.

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

  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 insert file headers 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.

This feature is supported in the following languages and technologies:

Language: C#Language: VB.NETLanguage: C++Language: HTMLLanguage: ASP.NETLanguage: RazorLanguage: JavaScriptLanguage: TypeScriptLanguage: CSSLanguage: XMLLanguage: XAMLLanguage: ResxLanguage: Build ScriptsLanguage: ProtobufLanguage: JSON
Feature is available in C# Feature is not available in Visual Basic .NETFeature is 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: 19 August 2021