JetBrains Rider 2020.3 Help

File Header Style

Your file header 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.

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

The configured file header could be inserted in new files if you create them using file templates. To do so, you should add a template parameter and associate the 'File header' macro with it.

If you want to apply the file header to existing files, you can do it with the code cleanup.

Configure a file header and insert it into code files with code cleanup

  1. Press Ctrl+Alt+S or choose File | Settings (Windows and Linux) or JetBrains Rider | Preferences (macOS) from the menu , 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. Go to the cleanup profiles settings page: Editor | Code Cleanup.

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

  6. Click Save in the Settings dialog to apply the modifications and let JetBrains Rider choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see Layer-Based Settings.

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

  8. Choose Code | Code Cleanup in the main menu.

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

  10. Click OK. JetBrains Rider will update file header in the selected scope.

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 . Ctrl+E, F . You can also create a custom cleanup profile that would combine inserting file headers with other code style tasks.

Last modified: 08 December 2020