需要文件标头 (IDE0073)

属性	值
规则 ID	IDE0073
标题	需要文件标头
类别	Style
Subcategory	语言规则（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

若要禁用所有代码样式规则，请在配置文件中将类别 Style 的严重性设置为 none。

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

有关详细信息，请参阅如何禁止显示代码分析警告。

另请参阅

• 代码样式语言规则
• 代码样式规则参考