Quelle est une bonne règle pour quand ajouter des membres avec 'this' (C#)?

Question

Si j'accède à un champ membre, à une propriété ou à une méthode, je ne sais jamais quand je devrais ajouter "ceci".

Je ne pose pas de questions sur les cas où cela est nécessaire, comme dans le cas où une variable locale porte le même nom. Je parle de cas où le sens est exactement le même. Lequel est le plus lisible? Y a-t-il des normes, des pratiques exemplaires ou des règles générales que je devrais suivre? Cela devrait-il être cohérent dans une classe ou dans une base de code entière?

Answer 1

Je recommande d'utiliser les directives de Microsoft, tel que vérifié par StyleCop: http://blogs.msdn.com/sourceanalysis/

La règle générale est, les membres de PREPEND avec "cela." quand ils sont définis dans la classe, à moins qu'ils ne soient statiques, auquel cas vous ne pouvez pas.

Voici la règle directement à partir StyleCop:

SA1101: The call to {method or property name} must begin with the 
'this.' prefix to indicate that the item is a member of the class. 

Answer 2

Dans mon code, je l'utilise seulement. <PropertyName> lorsque la propriété appartient à une classe de base et non à la classe dans laquelle je suis actuellement.

Bien sûr, ne pas utiliser 'ceci' est un autre choix populaire, car du code inutile est ajouté.

Answer 3

Je ne suis pas d'accord avec StyleCop sur celui-ci, et je ne suis même pas sûr que l'opinion de StyleCop devrait être interprétée comme une directive officielle Microsoft de toute façon. C'était un outil interne utilisé chez Microsoft mais toutes les équipes ne l'utilisent pas, et toutes les équipes n'utilisent pas toutes les règles.

Ajout de this partout n'est pas nécessaire et ajoute souvent un fouillis. Cela n'améliore pas les performances et je ne suis pas convaincu qu'ajouter this partout dans le code améliore la lisibilité soit. Vous pouvez entendre des arguments qui indiquent plus clairement où la variable est définie, mais je dirais que si votre classe/méthode est si longue et compliquée qu'il est difficile de savoir où quelque chose est déclaré, alors vous devriez probablement refactoriser de toute façon. Si vous utilisez le single responsibility rule et avez des fonctions courtes, il devrait être évident si une variable est un membre, un paramètre de fonction ou une variable locale.

Comme vous le signalez, parfois c'est nécessaire. Par exemple dans le constructeur si vous voulez définir un membre privé avec le même nom que le paramètre.

public class Foo 
{ 
    private Bar bar; 

    public Foo(Bar bar) 
    { 
     this.bar = bar; 
    } 
} 

Answer 4

Si vous suivez StyleCop Microsoft, vous devriez toujours utiliser les membres de la classe préfixe avec le mot-clé this.

SA1101: PrefixLocalCallsWithThis
TypeName: PrefixLocalCallsWithThis
CheckId: SA1101 Catégorie: Lisibilité Règles

Voici un similar StackOverflow question sur le même sujet.

Answer 5

J'accède habituellement aux paramètres sur l'objet courant avec ceci.Compte tenu d'une convention de nommage pour les variables d'instance « m_ », ce qui rend facile de voir en un coup d'oeil ce qui est touché par la suite des déclarations sans connaître leur contexte:

m_Height += 10; // an instance variable 
height += 10;  // a local variable 
this.Height += 10; // a property 

Answer 6

Je dirais d'éviter autant que possible, il vous permet d'économiser certains (en fait beaucoup de) taper.

Je dépendrais plus de Visual Studio pour m'aider à trouver ce qui appartient (n'oubliez jamais F12). Je n'utilise pas le bloc-notes pour lire mes fichiers cs: P

Answer 7

Nos normes de codage au travail stipulent que les variables membres ne doivent pas être préfixées avec «m» ou «_» ou tout ce que la plupart des gens utilisent. En fait, je me suis retrouvé à utiliser this.memberVariable tout le temps. Je préfère la clarté sur un peu de frappe supplémentaire. Et comme mentionné dans les autres réponses, il est nécessaire de faire référence à des paramètres portant le même nom que les variables membres.

Answer 8

Si vous utilisez Visual Studio et Intellisense. Lorsque vous tapez ceci, vous obtenez une liste de vos méthodes de variables au niveau de classe, etc. Ne tenez pas compte de tous les autres éléments possibles.