13 interesantes consejos para comentar tu código, que contribuirán a hacerlo más inteligible y por tanto a incrementar su mantenibilidad a lo largo del tiempo.
Si alguien me recomienda comentar mi código para hacerlo más inteligible (vaya término rebuscado!) con el fin de mejorar la mantenibilidad (¿de dónde habrá sacado el "palabro"?) le diría que prefiero que mi código sea más legible para simplificar su mantenimiento, ya que como comente su código de esa forma tan rebuscada seguirán sin entenderle...
Yo comentando código tengo una mala manía, y es crear parrafadas en una linea en vez de dividirla en bloques... hombre... algo tendra de culpa la resolucion con un ancho de 1440
Por lo demas, mas o menos uso similares tacticas de comentarlo.
Comentarios
Si alguien me recomienda comentar mi código para hacerlo más inteligible (vaya término rebuscado!) con el fin de mejorar la mantenibilidad (¿de dónde habrá sacado el "palabro"?) le diría que prefiero que mi código sea más legible para simplificar su mantenimiento, ya que como comente su código de esa forma tan rebuscada seguirán sin entenderle...
El mejor comentario es el que no está porque no hace falta.
Lo de comentar obligatoriamente una función para explicar que hace y como lo hace no me parece bien,
si está bien diseñada se explica por si sola.
Otra cosa es la anotación que creo que es a lo que se refiere al hablar de javadoc
La calidad de los comentarios del código fuente es directamente proporcional a la calidad del contrato laboral de quién te lo encarga.
Es decir, si es un contrato basura con una cárnica, codigo sin comentarios, con los nombres de variables ininteligibles y sin indentación...
A tomar por culo.
#1 Ojo, que puede ser perfectamente legible pero ser ininteligible, que son dos cosas distintas.
Yo comentando código tengo una mala manía, y es crear parrafadas en una linea en vez de dividirla en bloques... hombre... algo tendra de culpa la resolucion con un ancho de 1440
Por lo demas, mas o menos uso similares tacticas de comentarlo.
Están muy bien los consejos! Siempre se agradece cuando te llega un código fuente que este esté debidamente comentado