添加文件头

  • 项目

此代码生成适用于：

  • C#

  • Visual Basic

功能： 使用 EditorConfig 向现有文件、项目和解决方案添加文件头。

使用时机： 你希望能够轻松地向文件、项目和解决方案添加文件头。

操作原因：出于版权目的，你的团队要求你添加文件头。

操作说明

  1. 向项目或解决方案添加 EditorConfig（如果还没有的话）。

  2. 将以下规则添加到 EditorConfig 文件：file_header_template。

  3. 将规则的值设置为等于要应用的头文本。 对于文件名，可以使用 {fileName} 作为占位符。

    Screenshot of the EditorConfig file showing the file_header_template value.

    注意

    EditorConfig 中不能有显式多行，你需要使用 Unix 换行符来插入新行。

  4. 将插入点置于任何 C# 或 Visual Basic 文件的第一行。

  5. 按 (Ctrl+.) 触发“快速操作和重构”菜单。

  6. 选择“添加文件头”。

    Screenshot of the Add file header option.

  7. 若要将文件头应用于整个项目或解决方案，请选择“修复以下对象中的所有实例:”选项下面的“项目”或“解决方案”。

  8. 此时，“修复所有实例”对话框打开，你可以在其中预览更改。

    Fix all occurrences dialog

  9. 选择“应用”，以应用更改。

请参阅