파일 헤더 필요(IDE0073)

속성
규칙 ID 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

자세한 내용은 방법: 코드 분석 경고 표시 안 함을 참조하세요.

참고 항목