需要檔案標頭 (IDE0073)

屬性	值
規則識別碼	IDE0073
標題	需要檔案標頭
類別	樣式
子類別	語言規則 (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

如需詳細資訊，請參閱如何隱藏程式碼分析警告。

另請參閱

• 程式碼樣式語言規則
• 程式碼樣式規則參考