How to: Add a License to Code Files

• May 30, 2022
• 3 minutes to read

The Add Copyright Header code provider and the h template allow you to add a copyright comment at the beginning of a source code file.

This comment can contain a file name, company name, author, and a license.

The following example shows how to customize the h template to add a license to a copyright comment.

1. Choose the CodeRush | Code Templates… item in the CodeRush menu to access the code templates options page.

2. Select the 1-key | h template.

3. Add a license to the default copyright header. For example, the MIT license:

4. Click OK to save the changes and close the Templates options page.

5. Open the IDE | User Info options page and configure the “Company”, “First Name”, and “Last Name” fields for the default copyright header:

6. Open a source file and perform one of the following actions:

Add a License to All Project Files

1. Open the Editor | C# (Visual Basic) | Code Cleanup options page and choose the Add copyright header rule.

2. Configure the Add copyright header rule:

3. Clean up your project:

Note

If you do not want CodeRush to modify the existing copyright header after code cleanup, enable the Do not replace the existing copyright header during code cleanup option on the Editor | C# (Visual Basic) | Programming Style options page.