Convenciones de nomenclatura no hacen mejor código mantenible?

Question

Me gusta dar mis variables, métodos y objetos descriptivos nombres. Obviamente no va por la borda, pero te voy a dar un par de ejemplos.

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

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

Algunas personas podría optar por ir a la siguiente, que realmente no tiene sentido para mí, a menos que usted es un mecanógrafo perezoso.

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

El problema es cuando se tiene lógica con estas abreviaturas. Te muy confundido en cuanto a lo que está sucediendo.

Imagínese los siguientes objetos.

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 legibilidad va por el desagüe. Siempre existe el argumento de IntelliSense y simplemente se cierne sobre las variables para ver qué tipo son, o lo son. código legible, hace que para el código fácilmente comprensible.

¿Tiene convenciones de nombres hacen mejor código mantenible?

Answer 1

Sí , de las convenciones de nomenclatura supuesto hacer el código más fácil de mantener.

Es por eso que, en su primer día en una clase de programación, el profesor se huelen que si se llama a una variable x, o i ...

Hay que recordar que los nombres de las variables / métodos / clase, etc es puramente para el programador, ya que cuando se compila los mismos sólo tendrán direcciones de memoria.

usted tiene que tratar de utilizar un buen balance de convenciones, legibles auto Explanitory de nomenclatura, buenos comentarios y código bien estructurado para que el código sea más fácil de mantener.

Answer 2

Si, por cualquier variable que no tiene un alcance muy limitado.

Cuando el alcance de una variable es muy limitada, y cuando los códigos gira alrededor de esa variable, que pueden salirse con un nombre de variable de usar y tirar.

Por ejemplo, un contador en un bucle puede tener un nombre simple, si el cuerpo del bucle es pequeña y el contador no rellay tener ningún otro significado:

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

Las expresiones lambda puede ser más fácil de leer usando un nombre corto:

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

Sin embargo, cuando se utiliza nombres cortos no trate de abreviar algo. Si una sola letra o una abreviatura bien conocida no lo hacen, usted puede también ir para un nombre más largo.

Por ejemplo, usando n para un valor numérico, como en el exression lambda anteriormente, funcionaría. El uso de algo más largo que todavía es una abreviatura, como itnum o itmid hace que el nombre de acarreo más información, pero no lo suficiente para ser útil, por lo itemNumber o itemId sería mejor.

Answer 3

Cuando programo en lenguajes como C #, a menudo me doy mis variables de nombres cortos sólo porque es más fácil de escribir y que puede caber más código en la pantalla. Esto funciona bien cuando estás en la zona y saber exactamente lo que está todo, pero exactamente por las razones que usted ha mencionado, sería muy confuso para un extraño, o incluso a sí mismo algunas horas más tarde. maquillaje de buen IDE que sea muy fácil cambiar el nombre de variables, lo que sin duda me sugieren hacer antes de abandonar su proyecto para la noche, o seguramente antes de compartirlo.

Guffa plantea algunos puntos buenos sobre cuándo los nombres de variables cortas son las adecuadas.