ファイル ヘッダーが必要 (IDE0073)

財産	価値
ルール ID	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

警告を抑制する

1 つの違反のみを抑制する場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、ルールを再度有効にします。

#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

詳細については、「コード分析の警告を抑制する方法」を参照してください。

関連項目

• コード スタイルの言語規則
• コード スタイル規則リファレンス