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.