SlideShare una empresa de Scribd logo
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

Vertical vs Horizontal Software Architecture
Vertical vs Horizontal Software ArchitectureVertical vs Horizontal Software Architecture
Vertical vs Horizontal Software Architecture
Christian Hujer
 
Clean Code - Capítulo 5 formatting
Clean Code - Capítulo 5 formattingClean Code - Capítulo 5 formatting
Clean Code - Capítulo 5 formatting
David Ramírez
 
DevOps y CI/CD
DevOps y CI/CDDevOps y CI/CD
DevOps y CI/CD
AmandaValls1
 
An Introduction to Test Driven Development
An Introduction to Test Driven Development An Introduction to Test Driven Development
An Introduction to Test Driven Development
CodeOps Technologies LLP
 
Test Driven Development
Test Driven DevelopmentTest Driven Development
Test Driven Development
Kumaresh Chandra Baruri
 
Code review guidelines
Code review guidelinesCode review guidelines
Code review guidelines
Lalit Kale
 
Fundamentos de Pruebas de Software - Capítulo 2
Fundamentos de Pruebas de Software - Capítulo 2Fundamentos de Pruebas de Software - Capítulo 2
Fundamentos de Pruebas de Software - Capítulo 2
Professional Testing
 
Coding standard and coding guideline
Coding standard and coding guidelineCoding standard and coding guideline
Coding standard and coding guideline
Dhananjaysinh Jhala
 
The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019
The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019
The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019
corehard_by
 
El modelo de_espiral
El modelo de_espiralEl modelo de_espiral
El modelo de_espiral
Sergio Olivares
 
TDD (Test Driven Design)
TDD (Test Driven Design)TDD (Test Driven Design)
TDD (Test Driven Design)
nedirtv
 
BDD in Action - building software that matters
BDD in Action - building software that mattersBDD in Action - building software that matters
BDD in Action - building software that matters
John Ferguson Smart Limited
 
Modelos de proceso evolutivos – prototipos
Modelos de proceso evolutivos – prototiposModelos de proceso evolutivos – prototipos
Modelos de proceso evolutivos – prototipos
María Inés Cahuana Lázaro
 
Droit de la Propriété Intellectuelle.pdf
Droit de la Propriété Intellectuelle.pdfDroit de la Propriété Intellectuelle.pdf
Droit de la Propriété Intellectuelle.pdf
MouhssineToni1
 
Code Refactoring
Code RefactoringCode Refactoring
Code Refactoring
kim.mens
 
AGILE Model (SDLC).pptx
AGILE Model (SDLC).pptxAGILE Model (SDLC).pptx
AGILE Model (SDLC).pptx
MahithDias
 
PHP Unit y TDD
PHP Unit y TDDPHP Unit y TDD
PHP Unit y TDD
Emergya
 
Tema N° 5 Ingeniería de Requisitos y los Requisitos del Software
Tema N° 5 Ingeniería de Requisitos y los Requisitos del SoftwareTema N° 5 Ingeniería de Requisitos y los Requisitos del Software
Tema N° 5 Ingeniería de Requisitos y los Requisitos del Software
SaraEAlcntaraR
 
Ieee 12207
Ieee 12207Ieee 12207
FASES DEL RUP
FASES DEL RUPFASES DEL RUP
FASES DEL RUP
EmilyOrdez1
 

La actualidad más candente (20)

Vertical vs Horizontal Software Architecture
Vertical vs Horizontal Software ArchitectureVertical vs Horizontal Software Architecture
Vertical vs Horizontal Software Architecture
 
Clean Code - Capítulo 5 formatting
Clean Code - Capítulo 5 formattingClean Code - Capítulo 5 formatting
Clean Code - Capítulo 5 formatting
 
DevOps y CI/CD
DevOps y CI/CDDevOps y CI/CD
DevOps y CI/CD
 
An Introduction to Test Driven Development
An Introduction to Test Driven Development An Introduction to Test Driven Development
An Introduction to Test Driven Development
 
Test Driven Development
Test Driven DevelopmentTest Driven Development
Test Driven Development
 
Code review guidelines
Code review guidelinesCode review guidelines
Code review guidelines
 
Fundamentos de Pruebas de Software - Capítulo 2
Fundamentos de Pruebas de Software - Capítulo 2Fundamentos de Pruebas de Software - Capítulo 2
Fundamentos de Pruebas de Software - Capítulo 2
 
Coding standard and coding guideline
Coding standard and coding guidelineCoding standard and coding guideline
Coding standard and coding guideline
 
The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019
The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019
The Hitchhiker's Guide to Faster Builds. Viktor Kirilov. CoreHard Spring 2019
 
El modelo de_espiral
El modelo de_espiralEl modelo de_espiral
El modelo de_espiral
 
TDD (Test Driven Design)
TDD (Test Driven Design)TDD (Test Driven Design)
TDD (Test Driven Design)
 
BDD in Action - building software that matters
BDD in Action - building software that mattersBDD in Action - building software that matters
BDD in Action - building software that matters
 
Modelos de proceso evolutivos – prototipos
Modelos de proceso evolutivos – prototiposModelos de proceso evolutivos – prototipos
Modelos de proceso evolutivos – prototipos
 
Droit de la Propriété Intellectuelle.pdf
Droit de la Propriété Intellectuelle.pdfDroit de la Propriété Intellectuelle.pdf
Droit de la Propriété Intellectuelle.pdf
 
Code Refactoring
Code RefactoringCode Refactoring
Code Refactoring
 
AGILE Model (SDLC).pptx
AGILE Model (SDLC).pptxAGILE Model (SDLC).pptx
AGILE Model (SDLC).pptx
 
PHP Unit y TDD
PHP Unit y TDDPHP Unit y TDD
PHP Unit y TDD
 
Tema N° 5 Ingeniería de Requisitos y los Requisitos del Software
Tema N° 5 Ingeniería de Requisitos y los Requisitos del SoftwareTema N° 5 Ingeniería de Requisitos y los Requisitos del Software
Tema N° 5 Ingeniería de Requisitos y los Requisitos del Software
 
Ieee 12207
Ieee 12207Ieee 12207
Ieee 12207
 
FASES DEL RUP
FASES DEL RUPFASES DEL RUP
FASES DEL RUP
 

Último

Buscador de Eventos y Fiestas en España - Buscafiesta
Buscador de Eventos y Fiestas en España - BuscafiestaBuscador de Eventos y Fiestas en España - Buscafiesta
Buscador de Eventos y Fiestas en España - Buscafiesta
holabuscafiesta
 
Introducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdf
Introducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdfIntroducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdf
Introducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdf
AbbieDominguezGirond
 
TECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptx
TECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptxTECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptx
TECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptx
KatiuskaDominguez2
 
PC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdf
PC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdfPC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdf
PC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdf
JhenryHuisa1
 
primer manual de nuestra compañía de soporte
primer manual de nuestra compañía de soporteprimer manual de nuestra compañía de soporte
primer manual de nuestra compañía de soporte
eliersin13
 
Arquitectura de Sistema de Reservaciones
Arquitectura de Sistema de ReservacionesArquitectura de Sistema de Reservaciones
Arquitectura de Sistema de Reservaciones
AlanL15
 

Último (6)

Buscador de Eventos y Fiestas en España - Buscafiesta
Buscador de Eventos y Fiestas en España - BuscafiestaBuscador de Eventos y Fiestas en España - Buscafiesta
Buscador de Eventos y Fiestas en España - Buscafiesta
 
Introducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdf
Introducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdfIntroducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdf
Introducción_a_las_APIs_y_Desarrollo_Back-end-Abbie Dominguez Girondo.pdf
 
TECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptx
TECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptxTECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptx
TECLADO ERGONÓMICO Y PANTALLAS TACTILES.pptx
 
PC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdf
PC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdfPC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdf
PC-04-DISEÑOS DE PITS Y STOPES DE UNA MINA A TAJO ABIERTO.pdf
 
primer manual de nuestra compañía de soporte
primer manual de nuestra compañía de soporteprimer manual de nuestra compañía de soporte
primer manual de nuestra compañía de soporte
 
Arquitectura de Sistema de Reservaciones
Arquitectura de Sistema de ReservacionesArquitectura de Sistema de Reservaciones
Arquitectura de Sistema de Reservaciones
 

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