Ne les conventions de nommage rendre le code plus maintenable?

Question

Je tiens à donner à mes variables, méthodes et objets descriptifs noms. De toute évidence ne va pas par-dessus bord, mais laissez-moi vous donner quelques exemples.

public class Account
{
    public decimal Balance { get; set; }
}

Account account = new Account();
account.Balance = 1000;

Certaines personnes choisiraient d'aller pour la suite, ce qui ne m'a vraiment pas de sens, à moins que vous êtes un dactylo paresseux.

Account acc = new Account();
acc.Balance = 1000;

Le problème est quand vous avez logique avec ces abréviations. Vous obtenez extrêmement confus quant à ce qui se passe.

Imaginez les objets suivants.

public class Account { public DebitOrder DebitOrder { get; set; } }
public class DebitOrder { BankDetail BankDetail { get; set; } }
public class BankDetail {}

Account acc = new Account();
DebitOrder do = new DebitOrder();
BankDetail bd = new BankDetail();

if(acc.DebitOrder.SomeProperty == do.SomeProperty)
{

}

La lisibilité va dans le drain. Il y a toujours l'argument de IntelliSense et juste planant au-dessus de vos variables pour voir quel type ils sont ou ce qu'ils sont. Code Lisible, fait pour le code facilement compréhensible.

Est-ce les conventions de nommage de rendre le code plus maintenable?

Answer 1

Oui , des conventions de nommage bien sûr rendre le code plus maintenable.

C'est pourquoi, dans votre premier jour dans une classe de programmation, le conférencier vous gifler si vous appelez une variable x ou i ...

Vous devez vous rappeler que les noms des variables / méthodes / classe, etc est purement pour le programmeur, comme lors de la compilation de ces adresses ne seront à la mémoire.

vous devez essayer d'utiliser un bon équilibre des lisibles, des conventions de nommage d'auto-Explanitory, de bons commentaires et le code bien structuré pour rendre le code plus maintenable.

Answer 2

Oui, pour une variable qui ne dispose pas d'une portée très limitée.

Lorsque la portée d'une variable est très limitée, et lorsque le code tourne autour de cette variable, vous pouvez vous en sortir avec un nom de variable à jeter.

Par exemple, un compteur dans une boucle peut avoir un nom simple si le corps de la boucle est petit et le compteur ne rellay avoir un autre sens:

for (int i = 0; i < 10; i++) arr[i] = 0;

Les expressions lambda peut être plus lisible en utilisant un nom court:

var items = source.Select(n => n.ToString() + ".");

Cependant, lorsque vous utilisez des noms courts ne pas essayer d'abréger quelque chose. Si une seule lettre ou une abréviation bien connue ne le font pas, vous pouvez tout aussi bien aller pour un nom plus.

Par exemple, en utilisant n pour une valeur numérique, comme dans ce qui précède exression lambda, fonctionnerait. En utilisant quelque chose qui est plus encore une abréviation, comme itnum ou itmid rend le report de nom plus d'informations, mais pas assez pour être utile, si itemNumber ou itemId seraient mieux.

Answer 3

Lorsque je programme dans des langues comme C #, je vais souvent donner mes noms de variables courtes juste parce qu'il est plus facile de taper et je peux adapter à plus de code à l'écran. Cela fonctionne bien quand vous êtes dans la zone et de savoir exactement ce que tout est, mais pour les raisons que vous avez mentionné, il serait très déroutant pour un étranger, ou vous-même quelques heures plus tard. La marque de Nice IDE super facile à renommer les variables, que je vous conseille vraiment faire des avant de se éloigner de votre projet pour la nuit, ou certainement avant de le partager.

Guffa soulève quelques bons points sur lorsque les noms courts variables sont appropriés.