Puis-je enseigner à ReSharper un test nul personnalisé?

Question

ReSharper est assez intelligent pour savoir que string.Format nécessite un non nul argument de format il me met en garde contre quand j'écris simplement

_message = string.Format(messageFormat, args); 

où messageFormat peut en effet être nul. Dès que j'ajoute une condition pour cette variable:

if (!string.IsNullOrEmpty(messageFormat)) 
{ 
    _message = string.Format(messageFormat, args); 
} 

l'avertissement disparaît. Unfortunatelly il ne pas lorsque j'utilise une méthode d'extension:

if (messageFormat.IsNotNullOrEmpty()) 
{ 
    _message = string.Format(messageFormat, args); // possible 'null' assignment warning 
} 

Ma question est: est-il possible de enseigner ReSharper que ma méthode d'extension a la même signification que !string.IsNullOrEmpty(messageFormat)?

L'extension est définie comme:

public static bool IsNotNullOrEmpty([CanBeNull] this string value) => !IsNullOrEmpty(value); 

Answer 1

Oui il y a. Vous devez utiliser le ReSharper annotations pour guider l'analyse de ReSharper. Vous utilisez déjà [CanBeNull] alors ils sont déjà définis dans votre projet.

Celui que vous serez intéressé par est ContractAnnotationAttribute:

annotations du contrat vous permettent de définir les résultats attendus pour les entrées données, ou en d'autres mots, définir les dépendances entre le type de référence et les arguments booléens d'une fonction et sa valeur de retour. Le mécanisme des annotations de contrat permet de créer des API qui pourraient être consommées de manière plus simple et plus sûre.

Voici comment l'utiliser:

[ContractAnnotation("null => false")] 
public static bool IsNotNullOrEmpty(this string value) 
    => !string.IsNullOrEmpty(value); 

L'argument est une carte d'entrées possibles (null, notnull, true, false) aux sorties (null, notnull, canbenull, true, false, halt):

Voici un autre exemple:

[ContractAnnotation("foo: null => halt; bar: notnull => notnull")] 
public string Frob(string foo, string bar) 

signifie que la fonction décorée ne reviendra (ou jeter une exception) si vous passez null au paramètre foo et garantit qu'il ne reviendra pas null si vous passez une valeur non nulle à bar.

The documentation décrit la syntaxe plus en détail.

---

est ici ce qui se passe sans l'attribut:

L'avertissement disparaît après l'ajouter: