lunes, 4 de junio de 2018

La adecuada inevitabilidad de los nombres descriptivos

Sea cual sea la notación a emplear, es necesario que los nombres sean suficientemente descriptivos. No se deben eliminar vocales ni recortar palabras; así, nombres como Vehic, Nmbr, FchNcm deben evitarse, y en su lugar deberían emplearse Vehiculo, VehicNombre, FechaNacimiento.

        Para las variables que se incrementan o decrementan en los bucles, se utilizará por convención y comodidad los nombres i, j, k, m

        En cuanto a los métodos, se aconseja que aquéllos que devuelvan algún valor se nombren como si fueran una variable en la que se almacena dicho valor relativo a la acción; por ejemplo, una función que devuelve una suma se denominará int Suma(…), no int ObtenerSuma(…). Por otro lado, si el método no devuelve nada, es recomendable que sea descrito con un verbo que represente su acción; por ejemplo, void CerrarConexion(…). Esto último es también de aplicación si el método devuelve una variable de control relativa al resultado de la acción, pero no un valor calculado; por ejemplo, es más correcto bool CerrarConexion(…), que bool ConexionCerrada(…). Así, se prefieren las siguientes denominaciones:

·         int Sum(…) en lugar de int GetSum(…).

·         Connection NewConnection(…) en lugar de Connection GetConexion(…).

·         bool CloseConnection(…) en lugar de bool ConnectionClosed(…).

        Por último y para cerrar este apartado, se recuerda que los nombres de clases e interfaces se escriben en notación Pascal y en singular, salvo que cada instancia represente a más de un elemento conceptual, lo cual no es común.

miércoles, 16 de mayo de 2018

Notación Pascal y notación dromedario

Actualmente, los dos modos principales de denominar las variables en lenguajes procedimentales son: notación Pascal, recomendada por Microsoft®, y notación llamada "dromedario", de uso en las comunidades de software libre). Ambas se basan en la misma filosofía en cuanto a separación de palabras: si una variable consta de más de una palabra, se eliminan los espacios entre ellas y se escribe en mayúscula la primera letra de cada palabra, y sólo ésta.  La diferencia entre la notación Pascal y la notación dromedario es que en la segunda la primera letra de la variable va en minúscula. Así, StartTime en notación Pascal es startTime en dromedario. Esto es aplicable tanto a variables como a nombres de métodos, con la salvedad de los nombres de clases e interfaces, en cuyo caso la notación dromedario adopta el criterio de la notación Pascal; es decir, una clase con el nombre ArrayList se escribe igual en ambas notaciones.

También coinciden ambos en el criterio sobre las constantes, que representan usando la notación C: todas las letras en mayúsculas y uso del guión bajo para separar una palabra de la siguiente: CADENA_DE_CONEXION.

Visualmente, existe una pequeña ventaja de la notación Pascal respecto a la notación dromedario, y es que las palabras reservadas de la mayoría de los lenguajes de programación contemporáneos comienzan por minúscula. De esta manera, es más fácil distinguir de un primer vistazo las variables de las palabras reservadas