Comentarios
Los comentarios son anotaciones que podemos incluir en nuestro programa y que nos permiten aclarar ciertos aspectos del código. Estas indicaciones son ignoradas por el intérprete de Python.
Los comentarios se incluyen usando el símbolo almohadilla # y comprenden hasta el final de la línea.
# Universe age expressed in days
universe_age = 13800 * (10 ** 6) * 365
Los comentarios también pueden aparecer en la misma línea de código, aunque la guía de estilo de Python no aconseja usarlos en demasía:
stock = 0 # Release additional articles
Reglas para escribir buenos comentarios: [6]
Los comentarios no deberían duplicar el código.
Los buenos comentarios no arreglan un código poco claro.
Si no puedes escribir un comentario claro, puede haber un problema en el código.
Los comentarios deberían evitar la confusión, no crearla.
Usa comentarios para explicar código no idiomático.
Proporciona enlaces a la fuente original del código copiado.
Incluye enlaces a referencias externas que sean de ayuda.
Añade comentarios cuando arregles errores.
Usa comentarios para destacar implementaciones incompletas.
No hay comentarios.:
Publicar un comentario