Me gustaría saber si hay alguna convención para los comentarios y líneas comentadas, ó que sería lo más correcto. ¿Tanto comentarios como...

Uriel Torres

Uriel Torres

Pregunta
studenthace 4 años

Me gustaría saber si hay alguna convención para los comentarios y líneas comentadas, ó que sería lo más correcto.

¿Tanto comentarios como líneas de código comentadas llevan un solo espacio?

1 respuestas
para escribir tu comentario
    JULIO CESAR NAVARRO MORALES

    JULIO CESAR NAVARRO MORALES

    studenthace 4 años

    Los comentarios que contradicen el código son peores que ningún comentario. ¡Siempre dé prioridad a mantener los comentarios actualizados cuando cambie el código!

    Los comentarios deben ser oraciones completas. La primera palabra debe escribirse en mayúscula, a menos que sea un identificador que comience con una letra minúscula.

    Los comentarios en bloque generalmente constan de uno o más párrafos construidos a partir de oraciones completas, y cada oración termina en un punto

    Debe utilizar dos espacios después de un período de finalización de una oración en los comentarios de varias oraciones, excepto después de la oración final.

    Asegúrese de que sus comentarios sean claros y fácilmente comprensibles para otros hablantes del idioma en el que está escribiendo y se deben hacer en inglés.

    Comentario en bloque

    Los comentarios de bloque generalmente se aplican a los códigos que los siguen, y están sangrados al mismo nivel que ese código. Cada línea de un comentario de bloque comienza con un # y un solo espacio (a menos que sea texto sangrado dentro del comentario).

    # Comentario # Comentario

    Los párrafos dentro de un comentario de bloque están separados por una línea que contiene un solo #.

    Comentarios en línea

    Utilice los comentarios en línea con moderación.

    Un comentario en línea es un comentario en la misma línea que una declaración. Los comentarios en línea deben estar separados por al menos dos espacios de la declaración. Deben comenzar con un # y un solo espacio.

    print() # Comentario

    Los comentarios en línea son innecesarios y de hecho distraen si dicen lo obvio.

    Fuente: https://www.python.org/dev/peps/pep-0008/#block-comments

Curso Básico de Python [Empieza Gratis]

Curso Básico de Python [Empieza Gratis]

Aprende a programar desde cero con el lenguaje de mayor crecimiento en el planeta: Python. Descubre qué es un algoritmo y cómo se construye uno. Domina las variables, funciones, estructuras de datos, los condicionales y ciclos.

Curso Básico de Python [Empieza Gratis]
Curso Básico de Python [Empieza Gratis]

Curso Básico de Python [Empieza Gratis]

Aprende a programar desde cero con el lenguaje de mayor crecimiento en el planeta: Python. Descubre qué es un algoritmo y cómo se construye uno. Domina las variables, funciones, estructuras de datos, los condicionales y ciclos.