CA1812: Evitare classi interne prive di istanze

Causa

Non viene mai creata un'istanza di un tipo interno (a livello di assembly).

Descrizione regola

Questa regola tenta di individuare una chiamata a uno dei costruttori del tipo e segnala una violazione se non viene trovata alcuna chiamata.

I tipi seguenti non vengono esaminati da questa regola:

• Tipi di valori
• Tipi astratti
• Enumerazioni
• Delegati
• Tipi di matrice generati dal compilatore
• Tipi di cui non è possibile creare un'istanza e che definiscono static solo i metodi.

Se si applica System.Runtime.CompilerServices.InternalsVisibleToAttribute all'assembly analizzato, questa regola non contrassegna i tipi contrassegnati come internal (Friend in Visual Basic) per impostazione predefinita, perché un campo può essere usato da un assembly friend. Per analizzare comunque l'assembly, vedere Configurare il codice da analizzare.

Come correggere le violazioni

Per correggere una violazione di questa regola, rimuovere il tipo o aggiungere il codice che lo usa. Se il tipo contiene solo static metodi, aggiungere il static modificatore al tipo per impedire al compilatore di generare un costruttore di istanza pubblica predefinito.

Quando eliminare gli avvisi

È sicuro eliminare un avviso da questa regola. È consigliabile eliminare questo avviso nelle situazioni seguenti:

• La classe viene creata tramite metodi di reflection ad associazione tardiva, System.Activator.CreateInstancead esempio .

• La classe viene registrata in un contenitore di inversione del controllo (IoC) come parte del modello di inserimento delle dipendenze.

• La classe viene creata automaticamente dal runtime o ASP.NET. Alcuni esempi di classi create automaticamente sono quelle che implementano System.Configuration.IConfigurationSectionHandler o System.Web.IHttpHandler.

• La classe viene usata come parametro di tipo in una definizione di classe e ha un new vincolo . L'esempio seguente verrà contrassegnato dalla regola CA1812:

  internal class MyClass
  {
      public void DoSomething()
      {
      }
  }
  public class MyGeneric<T> where T : new()
  {
      public T Create()
      {
          return new T();
      }
  }
  
  MyGeneric<MyClass> mc = new MyGeneric<MyClass>();
  mc.Create();
  

Eliminare un avviso

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

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

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

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

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

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

• Ignora attributo InternalsVisibleTo

È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole di questa categoria (prestazioni) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Ignora attributo InternalsVisibleTo

Per impostazione predefinita, questa regola è disabilitata se l'assembly analizzato usa InternalsVisibleToAttribute per esporre i relativi simboli interni. Per specificare che la regola deve essere eseguita anche se l'assembly è contrassegnato con InternalsVisibleToAttribute, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true

Questa opzione è disponibile a partire da .NET 8.

Regole correlate

• CA1801: Rivedere i parametri non usati