Поделиться через

Добавление заголовка файла

Область применения этого формирования кода:

  • C#

  • Visual Basic

Что: добавьте заголовки файлов в существующие файлы, проекты и решения с помощью EditorConfig.

Когда: вы хотите легко добавить заголовок файла в файлы, проекты и решения.

Почему: ваша команда требует, чтобы вы включили заголовок файла для целей авторских прав.

Практические советы

  1. Добавьте EditorConfig в проект или решение, если вы не сделали этого раньше.

  2. Добавьте правило file_header_template в файл EditorConfig.

  3. Задайте правилу значение, соответствующее тексту заголовка, который требуется добавить. В качестве заполнителя для имени файла можно использовать {fileName}.

    Screenshot of the EditorConfig file showing the file_header_template value.

    Примечание.

    В EditorConfig нельзя явным образом указать несколько строк. Для добавления отдельных строк необходимо использовать символ новой строки, применяемый в системах Unix.

  4. Поместите курсор на первую строку файла C# или Visual Basic.

  5. Нажмите CTRL+., чтобы открыть меню Быстрые действия и рефакторинг.

  6. Выберите Add file header (Добавить заголовок файла).

    Screenshot of the Add file header option.

  7. Чтобы применить заголовок файла ко всем файлам проекта или решения, выберите Project (Проект) или Solution (Решение) для параметра Fix all occurrences in (Исправить все вхождения в).

  8. Откроется диалоговое окно Fix all occurrences (Исправить все вхождения), где можно просмотреть вносимые изменения.

    Fix all occurrences dialog

  9. Нажмите Применить, чтобы применить изменения.

См. также