Richiedi intestazione file (IDE0073)

  • Articolo
Proprietà Valore
ID regola IDE0073
Titolo Richiedi intestazione file
Categoria Stile
Subcategory Regole del linguaggio (using preferenze di direttiva)
Lingue applicabili C# e Visual Basic
Opzioni file_header_template

Panoramica

Questa regola di stile riguarda la fornitura di un'intestazione di file nella parte superiore dei file di codice sorgente.

Opzioni

Specificare il testo dell'intestazione richiesto impostando l'opzione file_header_template .

  • Quando il valore dell'opzione è una stringa non vuota, richiedere l'intestazione del file specificata.
  • Quando il valore dell'opzione è unset o una stringa vuota, non è necessaria un'intestazione di file.

Per informazioni sulla configurazione delle opzioni, vedere Formato opzione.

file_header_template

Proprietà Valore Descrizione
Nome opzione file_header_template
Valori di opzione stringa non vuota, facoltativamente contenente un {fileName} segnaposto Preferisce la stringa come intestazione di file necessaria.
unset o stringa vuota Non richiedere un'intestazione di file.
Valore dell'opzione predefinito 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

Eliminare un avviso

Se si vuole eliminare solo una singola violazione, aggiungere direttive di preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

#pragma warning disable IDE0073
// The code that's violating the rule is on this line.
#pragma warning restore IDE0073

Per disabilitare la regola per un file, una cartella o un progetto, impostare la relativa gravità su none nel file di configurazione.

[*.{cs,vb}]
dotnet_diagnostic.IDE0073.severity = none

Per disabilitare tutte le regole in stile codice, impostare la gravità per la categoria Style su none nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Vedi anche