Hat Namenskonventionen besser wartbaren Code zu machen?

Question

Ich mag meine Variablen, Methoden geben und Objekte beschreibende Namen. Offensichtlich nicht über Bord gehen, aber lassen Sie mich Ihnen ein paar Beispiele.

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

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

Einige Leute würden sie für die folgenden gehen, die nicht wirklich Sinn für mich, wenn Sie eine faule Schreibkraft sind.

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

Das Problem ist, wenn Sie Logik mit diesen Abkürzungen haben. Sie bekommen sehr verwirrt, was geschieht.

Stellen Sie sich die folgenden Objekte.

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)
{

}

Die Lesbarkeit geht in den Abfluss. Es gibt immer das Argument von Intellisense und nur Ihre Variablen schwebt über, um zu sehen, welche Art sie sind, oder was sie sind. Lesbarer Code, macht für leicht verständlichen Code.

Does Namenskonventionen machen besser wartbaren Code?

Answer 1

Ja , natürlich Namenskonventionen machen besser wartbaren Code.

Deshalb, in Ihrem ersten Tag in einer Programmiersprache Klasse, der Vortragende werden Sie klatscht, wenn Sie eine Variable x nennen, oder i ...

Sie müssen, dass die Namen von Variablen / Methoden / Klasse erinnern, etc ist lediglich für den Programmierer, als wenn diese nur Adressen Speicher sein kompiliert wird.

Sie müssen versuchen, eine gute Balance von lesbaren, Selbstexplanitory Namenskonventionen, guten Kommentaren zu verwenden und gut strukturierten Code besser wartbaren Code zu machen.

Answer 2

Ja, für jede Variable, die nicht nur einen sehr begrenzten Umfang hat.

Wenn der Umfang einer Variablen ist sehr begrenzt, und wenn der Code dreht sich um die Variable, können Sie mit einem Wegwerf-Variablennamen weg.

Zum Beispiel kann ein Zähler in einer Schleife einen einfachen Namen hat, wenn der Schleifenkörper klein ist und der Zähler nicht rellay andere Bedeutung nicht haben:

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

Lambda-Ausdrücke können besser lesbar sein, einen kurzen Namen mit:

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

Wenn jedoch kurzen Namen nicht versuchen, etwas abzukürzen. Wenn ein einzelner Buchstabe oder eine bekannte Abkürzung es nicht tun, können Sie genauso gut für einen längeren Namen gehen.

Zum Beispiel n für einen numerischen Wert verwendet wird, wie in der Lambda-exression oben würde, arbeiten. Mit etwas mehr, die noch eine Abkürzung ist, wie itnum oder itmid macht mehr Informationen die Namen tragen, aber nicht genug, um nützlich zu sein, so itemNumber oder itemId wäre besser.

Answer 3

Wenn ich in Sprachen wie C # programmieren, ich werde oft meinen Variablen kurze Namen geben, nur weil es einfacher zu geben, und ich kann mehr Code auf dem Bildschirm passen. Das funktioniert gut, wenn Sie in der Zone sind und genau wissen, was alles ist, aber für genau die Gründe, die Sie erwähnen, wäre es sehr für einen Außenstehenden verwirrend sein, oder sogar selbst ein paar Stunden später. Nizza IDE macht es super einfach Variablen zu benennen, die ich auf jeden Fall von Ihrem Projekt empfehlen tun würde für die Nacht vor zu Fuß entfernt, oder auf jeden Fall, bevor es zu teilen.

Guffa wirft einige gute Punkte über, wenn kurze Variablennamen sind angemessen.