C# : Voici comment éviter d’oublier de suffixer le nom de vos méthodes asynchrones par « async » dans Visual Studio

Les mot-clés « async » et « await » sont disponibles depuis la sortie du framework 4.5 en 2012. Ces mots-clés facilitent l’appel de méthode asynchrone en .Net et est à présent utilisé par tous les développeurs.

Bonne pratique : Le nom d’une méthode asynchrone doit se terminer par « Async ».

Une bonne pratique que l’on pourrait malheureusement parfois oublier. Heureusement, Visual Studio nous permet d’afficher un avertissement dans le cas où l’on oublierait cette pratique. Pour ce faire, il suffit de se rendre dans Tools > Options, puis dans le menu Text Editor > C# > Code Style > Naming.

Chaque règle est constituée d’une spécification, d’un style de nommage et d’une sévérité.

Spécifications

Une spécification est composée d’un ou plusieurs types de symboles, d’une ou plusieurs accessibilités, et d’un ou plusieurs modificateurs. Dans notre cas, nous aurons besoin du type de symbole méthode, et du modificateur « async », peu importe la portée de la méthode.

Style de nommage

Le style de nommage permet de préciser si un préfixe ou un suffixe est requis, un séparateur de nom et le style de capitalisation. Nous allons créer un style de nommage, dont le suffixe est « Async », avec une casse de type Pascal.

Sévérité

La dernière étape, est de lier notre spécification avec notre style de nommage, et définir la sévérité à appliquer.

Vous verrez à présent un avertissement apparaitre, si vous oubliez le suffixe Async.

You may also like...

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *