CA1058 : Les types ne doivent pas étendre certains types de base

Article
06/03/2023

Propriété	Value
Identificateur de la règle	CA1058
Titre	Les types ne doivent pas étendre certains types de base
Catégorie	Conception
Le correctif est cassant ou non cassant	Rupture
Activé par défaut dans .NET 8	Non

Cause

Un type étend l’un des types de base suivants :

Par défaut, cette règle examine uniquement les types visibles en externe, mais elle est configurable.

Description de la règle

Les exceptions doivent dériver de System.Exception ou de l’une de ses sous-classes dans l’espace de noms System.

Ne créez pas de sous-classe de XmlDocument si vous souhaitez créer une vue XML d’une source de données ou d’un modèle objet sous-jacent.

Collections non génériques

Utilisez et/ou étendez des collections génériques dans la mesure du possible. N’étendez pas de collections non génériques dans votre code, sauf si vous l’avez publié précédemment.

Exemples d’utilisation incorrecte

public class MyCollection : CollectionBase
{
}

public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}

Exemples d’utilisation correcte

public class MyCollection : Collection<T>
{
}

public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}

Comment corriger les violations

Pour corriger une violation de cette règle, dérivez le type à partir d’un autre type de base ou d’une collection générique.

Quand supprimer les avertissements

Ne supprimez pas d’avertissement de cette règle pour les violations relatives à ApplicationException. Vous pouvez sans risque supprimer un avertissement de cette règle pour les violations relatives à XmlDocument. Vous pouvez sans risque supprimer un avertissement concernant une collection non générique si le code a été publié précédemment.

Supprimer un avertissement

Si vous voulez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver et réactiver la règle.

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

Pour désactiver la règle sur un fichier, un dossier ou un projet, définissez sa gravité sur none dans le fichier de configuration.

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

Pour plus d’informations, consultez Comment supprimer les avertissements de l’analyse de code.

Configurer le code à analyser

Utilisez l’option suivante pour configurer les parties de votre codebase sur lesquelles exécuter cette règle.

Inclure des surfaces d’API spécifiques

Vous pouvez configurer cette option pour cette règle uniquement, pour toutes les règles auxquelles elle s’applique ou pour toutes les règles de cette catégorie (Conception) auxquelles elle s’applique. Pour plus d’informations, consultez Options de configuration des règles de qualité du code.

Inclure des surfaces d’API spécifiques

Vous pouvez configurer les parties de votre codebase sur lesquelles exécuter cette règle, en fonction de leur accessibilité. Par exemple, pour spécifier que la règle doit s’exécuter uniquement sur la surface d’API non publique, ajoutez la paire clé-valeur suivante à un fichier .editorconfig dans votre projet :

dotnet_code_quality.CAXXXX.api_surface = private, internal

Partage via