Cómo hacer buenos nombres de variables

Depende del idioma que esté utilizando, las convenciones de código en su proyecto, etc.

¿Por qué el lenguaje? Por lo general, en Smalltalk no puede decirle al compilador el tipo de variable, por lo que debe decirle al siguiente programador qué espera, generalmente eso se hace usando un sufijo con el nombre del tipo, por lo que es normal tener:

una cuerda

un número

otra cadena

y así…

También puede ser:

numberOfYears, o simplemente años, o yearCount

Una regla general es que los documentos de convenciones de código están hechos por el desarrollador más experimentado del equipo, el documento está dentro del sistema de control de versiones, todos pueden verlo y todas las actualizaciones del documento se publican para que todos sepan qué ha cambiado y por qué.

En el caso de Java, descubrí que usan las Convenciones del Código de Sun: http://www.oracle.com/technetwor…

Eso es exactamente como decir “somos estúpidos y no nos importa” … ¿Por qué?

Las convenciones de código son una forma de evitar defectos sistémicos. Los defectos sistémicos son defectos que las personas hacen … sistemáticamente … es decir, cometen esos errores una y otra vez. ¿Cómo haces que la gente deje de cometer esos errores antes incluso de tratar de corregirlos?

  1. No escriba código repetido. De esta manera, minimizará la aparición de esos defectos.
  2. Explique el defecto en las convenciones del código como algo que no debe escribirse en el proyecto, explique por qué y luego proponga una solución, que espero no introduzca más defectos.

http://www.comsis.org/pdf.php?id…

Al compilador o intérprete, por supuesto, no le importan los nombres de variables, por lo tanto, tenga en cuenta que el propósito de un nombre de variable es ser leído por personas . Usted elige buenos nombres de variables al enfocarse en quién lo leerá. Si el código es un proyecto personal que nunca espera mostrar a nadie más, elija un nombre que le recuerde su propósito. Pero para la mayoría de los códigos, debe elegir un nombre que indique su propósito a otra persona.

Apéguese a las convenciones del lenguaje y el proyecto en el que está trabajando, como UsingCamelCase vs. separating_words_with_underscores. Intenta comprometerte lo mejor que puedas entre algo descriptivo y algo breve. A menudo, los nombres de las variables son frases, y a menudo se puede reformular para que sea razonablemente breve sin sacrificar la comprensión, por ejemplo, utilizando el subrayado_separado en lugar de separado_con_colecciones.

Se consistente. Si usa “mayor” como parte de un nombre de variable en un lugar, úselo de manera coherente, en lugar de decir “mayor” y otras veces “máximo”.

Primero, definamos “bueno”. ¿Bueno para qué? ¿En qué tipo de programa? ¿Quién lo leerá? ¿Cuando? Eso se usará por cuánto tiempo y por cuántos. Y tendrá que ir a través de los idiomas (por ejemplo, el uso de R y SAS. Para diferentes propósitos).

Y, para ver un ejemplo hilarante de lo que no debe hacer, consulte Programación para la seguridad laboral. , particularmente la sección sobre convenciones de nomenclatura que comienza en la pág. 6 6

La mayoría de los idiomas tienen sus propias guías de estilo, generalmente los nombres cortos y descriptivos son los mejores. Lo suficientemente corto como para no ser difícil de manejar, lo suficientemente descriptivo como para que alguien que lo lea tenga una idea de lo que representa.