Todos sabemos realizar comentarios en el código fuente de una aplicación, sabemos que sirven para dejar notas, para las mejores practicas en el desarrollo de software, etc. ¿Quién no ha hecho este tipo de anotaciones en el código?, créanme, cuando te dedicas a dar mantenimiento a un sistema desearías que el desarrollador original se hubiera preocupado por hacer este tipo de anotaciones y ayudar un poco a su sucesor.
De igual forma, es normal realizar infinidad de pruebas y para ello algunas veces nos vemos en la necesidad de crear archivos de prueba y de nuevo pregunto ¿hay alguien que no lo haya hecho?.
¿A que voy con todo esto?
He participado en diversos proyectos como desarrollador web y en varios de ellos he dado mantenimiento a algunos, desarrollado otros, reutilizado código, etc. He de admitir que no siempre es posible seguir las buenas practicas, que no siempre comento todo mi código (aunque en algún proyecto fue obligatorio este punto y claro, nos quitó tiempo de desarrollo ya que teníamos que escribir literalmente algo como "este ciclo for imprime la lista de productos disponibles").
Probablemente muchos dirán "¡Pero eres ingeniero, debes ser capaz de saber qué hace el código simplemente con verlo!" y es cierto, pero en ocasiones "el cliente" tendrá su área de sistemas y literalmente revisará el código fuente, no sólo se limitará a revisar el funcionamiento del sistema e incluso aunque no se preocuparan por revisar la estructura y código del mismo nosotros (los desarrolladores) debemos preocuparnos por hacer nuestro trabajo lo mejor posible y de una forma limpia.
¿A dónde nos lleva esto?
Bien, les comentaré que hoy mientras revisaba un código fuente encontré muchos archivos prueba, muy pocos comentarios, un completo desorden de páginas con código, tenía archivos de documentación dentro del proyecto donde únicamente debería de haber código fuente, etc. No es la primera vez que me encuentro con esto pero lo preocupante es que había más de 30 archivos de prueba (archivos que ahora son basura), comentarios que decían algo como "A ver si esta chingadera funciona", "prueba pitera", etc. y los pocos comentarios que tenía contenían infinidad de errores ortográficos.
¿Saben por qué los ingenieros tenemos la fama de no saber escribir?, ¿por qué tenemos la fama de ser groseros e informales? ¡claro!, ¡por cuestiones de este tipo!
Sé que muchas veces pensamos "Da igual lo que diga la prueba, es para mi y sólo yo la voy a ver", esto es normal ya que siempre creemos que seremos los únicos en ver nuestro desarrollo, todo esto lo vamos dejando de lado, no quitamos archivos prueba, no eliminamos este tipo de comentarios ya que creemos que seremos los únicos que verán el código fuente pero cuando menos lo imaginas: ¡sorpresa!, llegó un nuevo desarrollador para hacer equipo contigo o bien eres cambiado de proyecto y debes moverte inmediatamente sin tener tiempo de eliminar este tipo de errores.
Recuerden que como ingenieros no pueden dedicarse únicamente al desarrollo, serán encargados de dar mantenimiento, soporte técnico a usuarios, documentar el proyecto, entre otros.
Yo les aconsejo que en cuanto su prueba funcione o sus comentarios momentaneos ya no sean necesarios los eliminen, en lo que llevo trabajando en el 70% de los casos, mis desarrollos han tenido que ser intervenidos por alguien más y no por el hecho de haber sido un mal trabajo sino porque el cliente, al ver que un sistema a la medida es justo lo que necesitaba y que hace maravillas tiende a solicitar la extensión del mismo, gran parte de estas ocasiones mis desarrollos han estado en manos de personas de mi misma empresa y otras tantas en manos de personal del cliente, ¿ahora se dan cuenta de la importancia de quitar este tipo de archivos y comentarios?
Espero que esto sirva para darse cuenta de la importancia de hacer las cosas con propiedad y de forma limpia, espero que esta experiencia sirva un poco a aquellos nuevos desarrolladores.
Nota: Si no saben cómo se escribe algo usen un diccionario (si, en Internet hay muchos y no, no quiero que parezca insulto).
Saludos
SNOW
No hay comentarios:
Publicar un comentario