File header style
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.
You can configure file header either in JetBrains Rider settings 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 JetBrains Rider settings
Press Ctrl+Alt+S or choose (Windows and Linux) or (macOS) from the menu , then choose 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 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.
Configure file header via EditorConfig
Open the .editorconfig file where you want to configure file header, or create a new one.
Add the
file_header_templateproperty to the file, for example:file_header_template=Your Company. \nSome info about {fileName}
Add file header to newly created files
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.
Insert file header into existing files with Code Cleanup
Press Ctrl+Alt+S or choose (Windows and Linux) or (macOS) from the menu .
Go to the cleanup profiles settings page: .
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 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.
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.
Press Ctrl+E, C or choose from the main menu .
In the Reformat and Cleanup Code dialog that opens, select the newly created profile and choose another scope if needed. .
Click OK. JetBrains Rider 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 Ctrl+E, F. You can also create a custom cleanup profile that would combine inserting file headers with other code style tasks.
You can update file header in code that you have recently modified and are going to commit to Git. JetBrains Rider will run the selected cleanup profile before committing.
Clean up code before committing it to Git
Press Ctrl+K or select from the main menu.
In the Commit tool window, click
and in the Before Commit area, select the Cleanup with... checkbox.Click Choose profile and choose your custom Code Cleanup profile.
Click Commit or Commit and Push. JetBrains Rider will run code cleanup on the ranges staged for the commit, and then commit the changes.
You can update file header every time you save changes in a file to make sure that your edits always comply with your code style. Note that this will only happen when you save changes explicitly with Ctrl+S or Ctrl+S and will not be triggered by auto-saving. However, all auto-saved files are placed to the 'reformat and cleanup' queue and will be processed on the next explicit save.
Automatically update file header on saving changes
Press Ctrl+Alt+S to open the IDE settings and select Tools | Actions on Save.
Select Reformat and Cleanup Code, choose your custom Code Cleanup profile and whether to apply it to the whole file or only to the changed lines.
The next time you finish editing and save the file or all files , JetBrains Rider will clean up the affected files using the selected profile.