Inline Comments
Lección 7 de 28 del curso Clean Code - Write better code using Python de Coddy.
Los comentarios en línea explican una sola sentencia en una parte del código.
- Escribe los comentarios en línea en la misma línea que la sentencia a la que se refieren.
- Separa los comentarios en línea por dos o más espacios de la sentencia.
- Comienzan con un
#y un solo espacio. - No los uses para explicar lo obvio.
Por ejemplo,
result = check(name) # Comprobar si el nombre es correctoLa mayoría de las veces preferirás usar bloques de comentarios en lugar de bloques en línea.
Desafío
FácilSe te proporciona un pequeño código que realiza un pequeño cálculo para aumentar el salary, escribe un comentario en línea que explique esta línea.
Esta es probablemente una explicación obvia, pero por el bien de nuestra práctica lo haremos...
Pruébalo tú mismo
salary = 1000
salary = salary * 1.05