Требование заголовка файла (IDE0073)

  • Статья
Свойство Значение
Идентификатор правила IDE0073
Title Требование заголовка файла
Категория Стиль
Подкатегория Языковые правила (using параметры директивы)
Применимые языки C# и Visual Basic
Параметры file_header_template

Обзор

Это правило стиля относится к созданию заголовка файла наверху файлов исходного кода.

Варианты

Укажите необходимый текст заголовка, задав file_header_template параметр .

  • Если значение параметра является непустой строкой, требуется указанный заголовок файла.
  • Если параметр имеет значение или является unset пустой строкой, не требуется использовать заголовок файла.

Сведения о настройке параметров см. в разделе Формат параметра.

file_header_template

Свойство Значение Описание
Имя параметра file_header_template
Значения параметра непустая строка, при необходимости содержащая {fileName} заполнитель Предпочитать строку в качестве обязательного заголовка файла.
unset или пустая строка Не требуется заголовок файла.
Значение параметра по умолчанию unset 
// file_header_template = Copyright (c) SomeCorp. All rights reserved.\nLicensed under the xyz license.

// Copyright (c) SomeCorp. All rights reserved.
// Licensed under the xyz license.
namespace N1
{
    class C1 { }
}

// file_header_template = unset
//      OR
// file_header_template =
namespace N2
{
    class C2 { }
}

' file_header_template = Copyright (c) SomeCorp. All rights reserved.\nLicensed under the xyz license.

' Copyright (c) SomeCorp. All rights reserved.
' Licensed under the xyz license.
Namespace N1
    Class C1
    End Class
End Namespace

' file_header_template = unset
'      OR
' file_header_template =
Namespace N2
    Class C2
    End Class
End Namespace

Отключение предупреждений

Если вы хотите подавить только одно нарушение, добавьте директивы препроцессора в исходный файл, чтобы отключить и снова включить правило.

#pragma warning disable IDE0073
// The code that's violating the rule is on this line.
#pragma warning restore IDE0073

Чтобы отключить правило для файла, папки или проекта, задайте для его серьезности none значение в файле конфигурации.

[*.{cs,vb}]
dotnet_diagnostic.IDE0073.severity = none

Чтобы отключить все правила в стиле кода, задайте серьезность для категории Stylenone в файле конфигурации.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none

Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.

См. также раздел