Fa convenzioni di denominazione rendere il codice più mantenibile?

Question

mi piace dare i miei variabili, metodi e oggetti descrittivi nomi. Ovviamente non andare a mare, ma mi permetta di darle un paio di esempi.

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

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

Alcune persone sarebbe scegliere di andare per la seguente, che in realtà non ha senso per me, a meno che non sei un dattilografo pigro.

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

Il problema è quando si ha la logica di queste abbreviazioni. Si ottiene estremamente confuso su ciò che sta accadendo.

Immaginate i seguenti oggetti.

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 leggibilità va giù per lo scarico. C'è sempre l'argomento di intellisense e poco si libra sopra le variabili per vedere che tipo sono, o quello che sono. codice leggibile, rende il codice facilmente comprensibile.

Lo convenzioni di denominazione rendere il codice più mantenibile?

Answer 1

Sì , di convenzioni di denominazione ovviamente rendere il codice più mantenibile.

Questo è il motivo per cui, nel tuo primo giorno in una classe di programmazione, il docente si smack se si chiama una variabile x, o i ...

Bisogna ricordare che i nomi delle variabili / metodi / classe, ecc è puramente per il programmatore, come quando compilato queste saranno solo gli indirizzi di memoria.

si deve cercare di utilizzare un buon equilibrio di convenzioni, leggibili explanitory di auto di denominazione, buoni commenti e il codice ben strutturato per rendere il codice più mantenibile.

Answer 2

Sì, per qualsiasi variabile che non ha un campo di applicazione molto limitato.

Quando l'ambito di una variabile è molto limitato, e quando il codice ruota attorno quella variabile, si possono ottenere via con un nome di variabile e getta.

Per esempio, un contatore in un ciclo può avere un nome semplice se il corpo del ciclo è piccolo e il contatore non dualita avere qualsiasi altra significato:

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

espressioni lambda può essere più leggibile utilizzando un nome breve:

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

Tuttavia, quando si utilizzano nomi brevi non cercare di abbreviare qualcosa. Se una singola lettera o una sigla ben noto non lo fanno, si può altrettanto bene andare a fare un nome più lungo.

Ad esempio, utilizzando n per un valore numerico, come nel Exression lambda sopra, funzionerebbe. Utilizzando più qualcosa che è ancora un'abbreviazione, come itnum o itmid rende il nome trasportare più informazioni, ma non abbastanza per essere utile, così itemNumber o itemId sarebbe meglio.

Answer 3

Quando ho programmare in linguaggi come C #, io spesso do le mie variabili nomi brevi solo perché è più facile da digitare e posso inserire più il codice sullo schermo. Questo metodo funziona bene quando si è nella zona e sapere esattamente che cosa è tutto, ma esattamente per le ragioni che hai citato, sarebbe molto confusa per un estraneo, o anche da soli un paio d'ore più tardi. make di Nizza IDE è super facile da rinominare variabili, che avrei sicuramente suggerire facendo prima di allontanarsi dal progetto per la notte, o certamente prima di condividerlo.

Guffa solleva alcuni punti buoni su quando i nomi delle variabili brevi sono appropriati.