Como desarrolladores cada día tenemos que bautizar miles de variables, algunas poco importantes otras de las que depende el funcionamiento correcto de nuestra aplicación. Debido a esto debemos ser consecuentes y tener cuidado y un poco de orden a la hora de ponerles nombre.
Ian Hickman, propone 5 reglas básicas con las que nombrar fácilmente a nuestras variables:
- Crea nombres de variable largos y descriptivos. No seas vago y dale un nombre lo más descriptivo posible, piensa que dentro de 10 años tendrás que revisar ese código (a mi me vale).
- Pon las unidades en los nombres de la variable. Si tu variable informa una medida o algo que pueda ser contado debería incluirse la unidad de medida en la que está el valor de la misma.
- Si estás usando el «Camel Case», piensa en usar «Capitalize». Si los nombres de la variables están compuestos por más de una palabra, evita las mayusculas en la segúnda palabra. (ejemploVariable o Ejemplovariable) (Está es cuestión de gustos…)
- Nunca uses variables con nombre
temp
. Estas variables generalmente ensucian el código ya que no aportan nada, siempre mejor informar que están alojando en su interior aunque sean temporales. int i
es perfecto para pequeños bucles. Nada de usar variables de una sola letra en bucles grandes, es realmente frustrante descifrar un código de 1000 líneas cargado de variables de una sola letra.
En conclusión, debemos pensar que el código SIEMPRE lo revisan un mínimo de 2 personas, en grupos de trabajo serán otros compañeros y en proyectos propios serás tu dentro de X meses (que será una persona completamente diferente que el que desarrolló la primera versión).
12 comentarios, 1 referencias
+
#