SlideShare una empresa de Scribd logo
1 de 8
David Pineda Moncada
comentarios
• Nada puede ser tan útil como un
comentario bien colocado.
• Nada puede ser tan perjudicial como un
viejo comentario
• los comentarios son, como mucho, un mal
necesario
• El uso adecuado de los comentarios es
compensar nuestra incapacidad para
expresarse en el código.
• Mas exprecion en codigo es menos
comentarios
• La verdad solo esta en el codigo
• El codigo malo genera comentarios
Buenos comentarios
• El mejor comentario es el que no se
escribe
• Usarlos para describir el return de un
metodo
• Explicar la intencion
• Advertencias
• Todo comments
Malos comentarios
• Por lo general son excusas para tener
codigo malo
• dificil de entender
• Comentarios redundantes
• comentarios engañosos
• Comentarios por mandatos(cada variable )
• Journal Comments
• Comentarios de ruido
• Marcador de poscicion
• Attributions and Bylines
• Commented-Out Code
• De informacion

Más contenido relacionado

La actualidad más candente

La actualidad más candente (9)

METODOLOGIA RUP
METODOLOGIA RUPMETODOLOGIA RUP
METODOLOGIA RUP
 
Sistemas de aire acondicionado de precisión
Sistemas de aire acondicionado de precisiónSistemas de aire acondicionado de precisión
Sistemas de aire acondicionado de precisión
 
INGENIERIA DE SOFTWARE - METODOLOGIA SCRUM, EJEMPLO PRACTICO, t3
INGENIERIA DE SOFTWARE - METODOLOGIA SCRUM, EJEMPLO PRACTICO, t3INGENIERIA DE SOFTWARE - METODOLOGIA SCRUM, EJEMPLO PRACTICO, t3
INGENIERIA DE SOFTWARE - METODOLOGIA SCRUM, EJEMPLO PRACTICO, t3
 
IEEE Std 830-1998.
IEEE Std 830-1998.IEEE Std 830-1998.
IEEE Std 830-1998.
 
Aseguramiento de calidad
Aseguramiento de calidadAseguramiento de calidad
Aseguramiento de calidad
 
Scrum basics
Scrum basicsScrum basics
Scrum basics
 
Clean Code - Clean Comments
Clean Code - Clean CommentsClean Code - Clean Comments
Clean Code - Clean Comments
 
Manifiesto agil
Manifiesto agilManifiesto agil
Manifiesto agil
 
Extreme programming(xp)
Extreme programming(xp)Extreme programming(xp)
Extreme programming(xp)
 

Clean code capitulo 4("Comments ")

  • 2. comentarios • Nada puede ser tan útil como un comentario bien colocado. • Nada puede ser tan perjudicial como un viejo comentario • los comentarios son, como mucho, un mal necesario
  • 3. • El uso adecuado de los comentarios es compensar nuestra incapacidad para expresarse en el código. • Mas exprecion en codigo es menos comentarios
  • 4. • La verdad solo esta en el codigo • El codigo malo genera comentarios
  • 5. Buenos comentarios • El mejor comentario es el que no se escribe • Usarlos para describir el return de un metodo • Explicar la intencion • Advertencias • Todo comments
  • 6. Malos comentarios • Por lo general son excusas para tener codigo malo • dificil de entender • Comentarios redundantes
  • 7. • comentarios engañosos • Comentarios por mandatos(cada variable ) • Journal Comments
  • 8. • Comentarios de ruido • Marcador de poscicion • Attributions and Bylines • Commented-Out Code • De informacion

Notas del editor

  1. Los comentarios viejos pierden la relacion con el codigo
  2. los programadores deben ser disciplinados suficiente para mantener a los comentarios en un alto estado de conservación, la relevancia y exactitud. la fabricación de un código tan claro y expresivo, que no necesita de los comentarios en el primer lugar. En lugar de gastar su tiempo a escribir los comentarios que explican el lío que has hecho, lo gastan limpiar ese desastre.
  3. Commented-Out Code Es codigo que esta comentado por personas que no son capaces de borrarlo porque creen que tendra alguna importancia Ademas que pueden confundir a los que lean el codigo Informacion mucha, en el lugar incorrecto , no es ovio lo que se quiere decir