Artículo sobre los comentarios
Mike Clark ha escrito un artículo bastante interesante en Sticky Minds titulado "Write Sweet-Smelling Comments", que toca un tema sobre el que siempre me ha gustado discutir.
A mí no me gusta ver demasiados comentarios en el código, en parte porque me molestan mucho y no me dejan leer lo que verdaderamente quiero leer, que es el código. Prefiero nombrar los métodos y variables de forma que su nombre hable por sí mismo, en vez de explicar su significado en un comentario.
Ahora mismo no recuerdo dónde lo escuché la primera vez, puede que fuera algún antiguo jefe, pero si necesitas comentar tu código, normalmente ésa es la primera señal que te indica que deberías refactorizarlo.
Por supuesto, otra cosa es que quieras generar documentación del estilo de javadoc, ahí la cosa cambia, pero es o es algo que tampoco he hecho nunca, y que daría para otra discusión bastante larga.
Aquí está otra vez el link al artículo ( via The Server Side )
Comentarios
Me he visto reflejado en algunos de los ejemplos, como el de que se te desactualicen los comentarios (que triste suena :-), y estoy de acuerdo que de las principales utilidades de utilizar comentarios es cuando el código lo tocan varios desarrolladores, para indicar modificaciones, añadidos etc.
De todas formas yo formo parte del grupo de flasheros que viene del diseño (a los que terminos como refactorizar nos hacen gracia e inquietan por igual), y como la ignorancia es germen de mitos y leyendas, a veces me siento como un Neanderthal mirando al cielo, buscandole sentido a los rayos y apuntito de fundar una religión. A veces tienes una "epifania racionalista" y tratas de fijarla al universo comentandola y recomentandola, incluso poniendo exclamaciones para dar enfasis al descubrimiento en plan "Devuelve una cadena!!!!!!". Que luego, despues de 1 mes y 'n' bugs la borras un poco avergonzado.
De todas formas, pido un articulo similar sobre los trace. Para que tener comentarios si puedes tener traces??,... traces que luego comentas cuando al pinchar en botón salen 300 lineas en la ventana de salida y tardas 20 min en encotrar el que buscabas.
Yo que tengo una identidad secreta como "Trace-Man" me gusta mirar la ventana de salida cuando me pasan una peli de otro desarrollador. A veces te llevas sorpresas leyendo esos trace que el que los escribió nunca pensó que los fuese a leer otro excepto el ("a toma poculo la bicha") para indicar que se ha matado el malo o el jugador.
Y ahora una duda técnica de verdad. Corre entre los Neanderthal-flasheros la leyenda urbana que poner nombres largos y descriptivos a variables y metodos luego afecta "algo" al rendimiento del código una vez compilado. Se sabe algo de esto? Si me podeis (o puedes, Tarda pq pa que engañarnos, esto no es el foro de Ultrashock) dar alguna pista podría utilizarla para convertirme en chaman de la tribu de neandertales a.k.a "autodidactas" que me rodea :-)
Publicado por: elSuricatoRojo | Mayo 24, 2005 10:14 AM