Nombres coherentes al programar, una buena costumbre.

N

tips1Hace algunas horas asesoraba a unos amigos con el desarrollo de un sistema como proyecto escolar, estuvimos aproximadamente 5 horas solucionando varios «detalles» que tenian en su codigo, mas que nada por los nombres que utilizaban a la hora de programar, la verdad se me hizo un infierno darle mantenimiento a su sistema, lo que me hizo pensar, ¿Por que la gente no utiliza nombres relacionados con las acciones de sus metodos o variables a la hora de escribirlos?, digo, así sería mucho mas fácil entender el código, ya sea que este escrito en ingles o en español, la verdad que utilizar nombres como «mtrz», «li»,»x»,»y»,o incluso «metodo» son practicas muy deficientes a la hora de desarrollar codigo, por ejemplo:

Supongamos que tenemos varios metodos para actualizar distintas cosas de algunas clases dentro de una sola clase, vamos a suponer, una clase ListaDeAlumnos,ListaDeProfesores,ListaDeProyectos,ListaDeResidentes, una mala practica sería utilizar dentro de una clase manejadora metodos como:

actualizara

actualizarp

actualizarp2

actualizarr

Supongamos que dentro de unas clases que sean pequeñas a la hora de entenderle no tengamos problemas ya que nosotros estamos escribiendo el codigo, pero bueno, supongamos tambien, que posteriormente pasamos el sistema a algun amigo para que analice el codigo, o simplemente (como me pasó) nos ayude con algun pequeño bug que nuestro sistema no este tomando en cuenta, a uno como asesor se le hace un infierno entender el codigo, no seria lo mismo, y creo que estamos de acuerdo, escribir los nombres un poco mas claramente como:

«actualizar_lista_alumnos» o  «update_students»

actualizar_profesores

actualizar_proyectos

actualizar_residentes

Digo, en lo personal seria un poco mas sencillo entender el codigo, ¿o no estamos de acuerdo?, creo que a la hora de escribir nuestro programa sería una buena practica el hecho de ponerle nombres relacionados a las variables con lo que hacen, en su caso tambien sería optimo colocar un nombre con la acción que hace a los metodos, por ejemplo, me toco ver nombres de las variables como:

x , y ,mtz, lA1

O metodos con nombres tan similares que simplemente no sabes cual hace cual cosa, como

actualizarBancoResidenciasProfesionales

actualizarResidenciasProfesionales

actualizarBancoResidenciasProfesional

actualizarBancoResidencias

Todo dentro de una misma clase!!! O.o

Y bueno, ¿estamos de acuerdo que a simple vista no se entiende ni se tiene la menor idea de que es lo que significan estas variables?, la verdad si eres un programador novato (no me considero avanzado) te recomiendo como buena practica utilizar nombres relacionados con lo que contendran las variables o los metodos, por muy redundante que se escuche, si tengo una variable que almacenara el area, un nombre redundante pero lógico, seria colocarle el nombre:

area    (o no??? O.o )

De verdad, sonara algo tonta la redundancia del post, pero es impresionante darse cuenta de que aun existen muchas personas que tienen estas malas practicas, en mi experiencia pasada, eran mas de 5000 lineas de codigo, y revisar, vamos a suponer, 500, de esa manera? la verdad es un infierno, facilitense la vida, utilicen nombres sencillos, relacionados con las acciones que haran, si es actualizar, no nos quita nada utilizar la misma palabra o incluso ponerla en ingles, no se, utilizar update_list_students (por decir un ejemplo) o utilizar palabras como, llenarArreglo, no se ve a simple vista de manera ambigua, usen buenas practicas al programar, y escuchen consejos. jajaja! Si a mis compañeros les a tocado leer el blog, se que se identificaran demasiado.

Y tu ¿Que nombres escoges a la hora de programar? O.o

Acerca del autor

Ivan Alvarado Diaz

Ingeniero en sistemas computacionales, apasionado por la tecnologia, programador, siempre con ganas de aprender mas y comprometido con mi trabajo.

Categorías

Etiquetas