CA1200 : Éviter d’utiliser des balises cref avec un préfixe

  • Article
Propriété Value
Identificateur de la règle CA1200
Titre Éviter d’utiliser des balises cref avec un préfixe
Catégorie Documentation
Le correctif est cassant ou non cassant Sans rupture
Activé par défaut dans .NET 8 Non

Cause

La balise cref dans un commentaire de documentation XML utilise un préfixe.

Description de la règle

L’attribut cref dans une balise de documentation XML signifie « référence de code ». Il indique que le texte interne de la balise est un élément de code tel qu’un type, une méthode ou une propriété. Évitez d’utiliser les balises cref avec des préfixes, car cela empêche le compilateur de vérifier les références. Cela empêche également l’environnement de développement intégré (IDE) de Visual Studio de rechercher et de mettre à jour ces références de symboles pendant les refactorisations. Il est recommandé d’utiliser la syntaxe complète sans préfixes pour référencer les noms de symboles dans les balises cref.

Comment corriger les violations

Pour corriger une violation de cette règle, supprimez le préfixe de la balise cref. Par exemple, les deux extraits de code suivants montrent une violation de la règle et comment la corriger :

// Violates CA1200
/// <summary>
/// Type <see cref="T:C" /> contains method <see cref="F:C.F" />
/// </summary>
class C
{
    public void F() { }
}

// Does not violate CA1200
/// <summary>
/// Type <see cref="C" /> contains method <see cref="F" />
/// </summary>
class C
{
    public void F() { }
}

Quand supprimer les avertissements

Il est prudent de supprimer cet avertissement si la référence de code doit utiliser un préfixe, car le type référencé n’est pas trouvable par le compilateur. Par exemple, si une référence de code fait référence à un attribut spécial dans l’infrastructure complète, mais que le fichier est compilé sur l’infrastructure portable, vous pouvez supprimer cet avertissement.

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 CA1200
// The code that's violating the rule is on this line.
#pragma warning restore CA1200

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.CA1200.severity = none

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

Voir aussi