Block Comments
Lección 6 de 28 del curso Clean Code - Write better code using Python de Coddy.
“Si la implementación es difícil de explicar, es una mala idea.”
- El Zen de Python
Los comentarios son importantes para que cualquier persona que lea tu código pueda entenderlo.
Los comentarios en Python se dividen en 3 tipos:
- Comentarios de bloque
- Comentarios en línea
- Cadenas de documentación (Docstrings)
Empecemos por los Comentarios de bloque -
- Comienzan desde el mismo bloque de sangría que el código que describen.
- Comienzan cada línea con un
#seguido de un solo espacio.
Por ejemplo,
while i < 10:
# Iterar sobre i hasta que i < 10
# imprimir i con una nueva línea e incrementarlo en 1
print(i, '\n')
i += 1
Desafío
FácilSe te proporciona la función greet; escribe un comentario de bloque para describir qué hace esta función, con tus propias palabras.
¡Sigue las reglas!
Pruébalo tú mismo
def greet(name):
print('Hello', name)