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.
Your file header preferences are saved using the mechanism of shared 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.
If you want to apply the file header to existing files, you can do it with the code cleanup as described below.
To configure a file header and insert it into code files
- Open ReSharper | Options | Code Editing | File Header Text.
- 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 on 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.
- Open the Code Cleanup options: ReSharper | Options | Code Editing | Code Cleanup.
- Create a new profile as described in the Configuring Code Clenup section. In the Selected profile settings section for the new profile tick the Update file header check box.
- Click Save 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 drop-down list. For more information, see Managing and Sharing 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:
- Choose on the main menu.
- Press Ctrl+Alt+F.
- 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 box that opens, select the newly created profile in the Available Profiles area.
- Click Run. ReSharper will update file header in the selected scope according to your preferences.
If you want to insert file headers without opening the Code Cleanup dialog box, you can bind the created profile to the silent cleanup and run it simply by pressing Ctrl+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/technologies:
- Naming Style
- Navigating Between Code Issues
- Finding Out What Is Wrong with Your Code
- Code Formatting Rules
- File and Type Layout
- File Header Style
- Namespace Imports Assistance
- Implicit/Explicit Typing
- Using Auto-Properties
- Making Fields Readonly
- Attributes Style
- Arranging Modifiers
- Arranging Optional Member Qualifiers
- Reformatting XML Doc Comments
- Removing Code Redundancies