Ensemble de règles de règles de conception de base pour le code managé
Vous pouvez utiliser l'ensemble de règles Règles de conception de base Microsoft afin de faciliter la compréhension et l'utilisation de votre code.Incluez cet ensemble de règles si votre projet comprend du code de bibliothèque ou si vous souhaitez mettre en vigueur des meilleures pratiques pour du code qui est facile à tenir à jour.
Les Règles de conception de base incluent toutes les règles dans l'ensemble de règles Règles Microsoft minimales recommandées.Pour obtenir une liste des règles minimales, consultez Ensemble de règles des règles recommandées managées pour le code managé.
Le tableau suivant décrit toutes les règles de l'ensemble de règles Règles de conception de base Microsoft.
Règle |
Description |
|---|---|
Les types qui possèdent des champs supprimables doivent être supprimables |
|
Déclarer les gestionnaires d'événements correctement |
|
Marquer les assemblies avec AssemblyVersionAttribute |
|
Les méthodes d'interface doivent pouvoir être appelées par les types enfants |
|
Les types qui possèdent des ressources natives doivent être supprimables |
|
Déplacer les P/Invoke vers une classe NativeMethods |
|
Ne pas masquer les méthodes de la classe de base |
|
Implémenter IDisposable correctement |
|
Ne pas lever d'exceptions dans des emplacements inattendus |
|
Éviter les accélérateurs en double |
|
Des points d'entrée P/Invoke doivent exister |
|
Les P/Invoke ne doivent pas être visibles |
|
Les types auto structurant ne doivent pas être visibles par COM |
|
Appeler GetLastError immédiatement après P/Invoke |
|
Les types de base de type visibles par COM doivent être visibles par COM |
|
Les méthodes d'inscription COM doivent être correspondre |
|
Déclarer correctement les méthodes P/Invoke |
|
Supprimer les finaliseurs vides |
|
Les champs de type valeur doivent être portables |
|
Les déclarations P/Invoke doivent être portables |
|
Ne définissez pas un verrou sur des objets à identité faible |
|
CA2100 : Rechercher des failles de sécurité dans des requêtes SQL |
|
Spécifiez le marshaling pour les arguments de chaîne P/Invoke |
|
Vérifiez la sécurité déclarative dans les types valeur |
|
Les pointeurs ne doivent pas être visibles |
|
Les types sécurisés ne doivent pas exposer de champs |
|
La sécurité de la méthode doit être un sur-ensemble du type |
|
Les méthodes APTCA doivent uniquement appeler des méthodes APTCA |
|
Les types APTCA doivent uniquement étendre des types de base APTCA |
|
N'exposez pas indirectement des méthodes avec des demandes de liaison |
|
Les demandes de liaison de surcharge doivent être identiques au composant de base |
|
Incluez dans un wrapper les clauses finally vulnérables dans un bloc try externe |
|
Les demandes de liaison de types nécessitent des demandes d'héritage |
|
Les types critiques de sécurité ne peuvent pas participer à l'équivalence des types |
|
Les constructeurs par défaut doivent être au moins aussi critiques que les constructeurs par défaut de type de base |
|
Les délégués doivent lier les méthodes avec une transparence cohérente |
|
Les méthodes doivent garder une transparence consistente lors de la surcharge de méthodes de base |
|
Les méthodes transparentes doivent contenir uniquement des IL vérifiables |
|
Les méthodes transparentes ne doivent pas appeler les méthodes ayant l'attribut SuppressUnmanagedCodeSecurity |
|
Le code transparent ne doit pas faire référence à des éléments critiques de sécurité |
|
Les méthodes transparentes ne répondent pas aux LinkDemands |
|
Les types doivent être au moins aussi critiques que les types de base et les interfaces |
|
Les méthodes transparentes ne peuvent pas utiliser d'assertions de sécurité |
|
Les méthodes transparentes ne doivent pas appeler du code natif |
|
Levez à nouveau une exception pour conserver les détails de la pile |
|
Ne pas supprimer des objets plusieurs fois |
|
Initialisez les champs statiques des types valeur sur une ligne |
|
Ne marquez pas les composants pris en charge avec WebMethod |
|
Les champs pouvant être supprimés doivent l'être |
|
N'appelez pas de méthodes substituables dans les constructeurs |
|
Les types pouvant être supprimés doivent déclarer un finaliseur |
|
Les finaliseurs doivent appeler le finaliseur de leur classe de base |
|
Implémentez des constructeurs de sérialisation |
|
Surcharger l'opérateur égal (equals) en remplaçant ValueType.Equals |
|
Marquez les points d'entrée Windows Forms avec STAThread |
|
Marquez tous les champs non sérialisés |
|
Appelez les méthodes de la classe de base sur les types ISerializable |
|
Marquer les types ISerializable avec SerializableAttribute |
|
Implémentez les méthodes de sérialisation comme il se doit |
|
Implémentez correctement ISerializable |
|
Fournissez des arguments corrects aux méthodes de mise en forme |
|
Effectuez correctement des tests NaN |
|
Ne pas déclarer de membres statiques sur les types génériques |
|
Ne pas exposer de listes génériques |
|
Ne pas utiliser d'instances du gestionnaire d'événements génériques |
|
Les méthodes génériques doivent fournir un paramètre de type |
|
Éviter les paramètres excessifs sur les types génériques |
|
Ne pas imbriquer les types génériques dans les signatures de membre |
|
Utiliser des classes génériques lorsque cela est approprié |
|
Les enums doivent avoir la valeur zéro |
|
Les collections doivent implémenter une interface générique |
|
Si possible, transmettez les types de base en tant que paramètres |
|
Les types abstraits ne doivent pas avoir de constructeurs |
|
Surchargez l'opérateur égal lors de la surcharge de l'opérateur d'addition et de soustraction |
|
Marquer les assemblies avec CLSCompliantAttribute |
|
Marquer les assemblies avec ComVisibleAttribute |
|
Marquer les attributs avec AttributeUsageAttribute |
|
Définir des accesseurs pour les arguments d'attribut |
|
Les indexeurs ne doivent pas être multidimensionnels |
|
Utiliser les propriétés lorsque cela est approprié |
|
Remplacer les arguments répétitifs par un tableau de paramètres |
|
Les paramètres par défaut ne doivent pas être utilisés |
|
Marquer les enums avec FlagsAttribute |
|
Le stockage d'Enum doit être Int32 |
|
Utiliser des événements lorsque cela est approprié |
|
Ne pas intercepter des types d'exception générale |
|
Implémenter des constructeurs d'exception standard |
|
Les types imbriqués ne doivent pas être visibles |
|
Les implémentations de ICollection possèdent des membres fortement typés |
|
Substituer les méthodes sur les types comparables |
|
Les énumérateurs doivent être fortement typés |
|
Les listes sont fortement typées |
|
Fournir un message ObsoleteAttribute |
|
Utiliser un argument de chaîne ou intégral pour les indexeurs |
|
Les propriétés ne doivent pas être en écriture seule |
|
Ne pas surcharger l'opérateur égal sur les types référence |
|
Ne pas déclarer des membres protégés dans les types sealed |
|
Ne pas déclarer les membres virtuels dans les types sealed |
|
Déclarer les types dans des espaces de noms |
|
Ne pas déclarer de champs d'instances visibles |
|
Les types de conteneurs statiques doivent être sealed |
|
Les types de conteneurs statiques ne doivent pas comporter de constructeur |
|
Les paramètres Uri ne doivent pas être des chaînes |
|
Les valeurs de retour Uri ne doivent pas être des chaînes |
|
Les propriétés Uri ne doivent pas être des chaînes |
|
Les surcharges d'uri de chaîne appellent les surcharges de System.Uri |
|
Les types ne doivent pas étendre certains types de base |
|
Les membres ne doivent pas exposer certains types concrets |
|
Les exceptions doivent être publiques |
|
Les noms de variables ne doivent pas être identiques aux noms de champs |
|
Éviter l'excès de complexité |
|
Les identificateurs ne doivent pas différer que par leur casse |
|
Les identificateurs ne doivent pas correspondre à des mots clés |
|
Passez en revue les paramètres inutilisés |
|
Supprimez les variables locales inutilisées |
|
Évitez le surplus de variables locales |
|
Initialisez les champs statiques de type référence en ligne |
|
Évitez le recours à du code privé non appelé |
|
Évitez les classes internes non instanciées |
|
Évitez les attributs unsealed |
|
Utilisez des tableaux en escalier à la place de tableaux multidimensionnels |
|
Surchargez Equals et l'opérateur égal dans les types valeur |
|
Les propriétés ne doivent pas retourner de tableaux |
|
Vérifiez la présence de chaînes vides en utilisant la longueur de chaîne |
|
Marquez les membres comme static |
|
Évitez les champs privés inutilisés |
|
Ne levez pas des types d'exceptions réservés |
|
Utilisez des équivalents managés de l'API Win32 |
|
Instanciez les exceptions d'argument comme il se doit |
|
Les champs non constants ne doivent pas être visibles |
|
Ne pas marquer les enums avec FlagsAttribute |
|
Ne pas lever d'exceptions dans les clauses d'exception |
|
Les finaliseurs doivent être protégés |
|
Ne réduisez pas la visibilité des membres hérités |
|
Les membres ne doivent pas différer uniquement par leur type de retour |
|
Remplacez Equals au moment de surcharger l'opérateur égal |
|
Les surcharges d'opérateur offrent d'autres méthodes nommées |
|
Les opérateurs doivent contenir des surcharges symétriques |
|
Les propriétés de collection doivent être en lecture seule |
|
Utilisez le mot clé params pour les arguments de variables |
|
Passez des objets System.Uri à la place de chaînes |
|
Spécifiez des méthodes de désérialisation pour les champs facultatifs |