Необходимо наличие заголовка файла (IDE0073)
Свойство | Ценность |
---|---|
идентификатор правила | IDE0073 |
Заголовок | Требуется заголовок файла |
категория | Стиль |
Подкатегория | Языковые правила (предпочтения директивыusing ) |
применимые языки | C# и Visual Basic |
Опции | file_header_template |
Обзор
Это правило стиля касается предоставления заголовка файла в верхней части файлов исходного кода.
Параметры
Укажите необходимый текст заголовка, задав параметр file_header_template
.
- Если значение параметра является непустой строкой, требуется указанный заголовок файла.
- Если значение опции
unset
или пустая строка, заголовок файла не требуется.
Для получения информации о настройке параметров см. Формат параметров.
шаблон_заголовка_файла
Свойство | Ценность | Описание |
---|---|---|
имя параметра | 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
Чтобы отключить все правила стиля кода, задайте уровень серьезности для категории Style
, чтобы none
в файле конфигурации .
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
Дополнительные сведения см. в статье Подавление предупреждений анализа кода.
См. также
- правила языка стиля кода
- справочник по правилам стиля кода