Comentar Código - gisminero/gepromi GitHub Wiki
Comentar código en Python
Es recomendable realizar comentarios en los métodos, esto es importante para que el código quede mejor documentado en sí mismo. Los comentarios en Python, al igual que sucede en otros lenguajes de programación, sirven para explicar a las personas que puedan leer el programa en el futuro, qué es lo que hace el programa, así como explicar algunas partes del código
En python los comentarios se pueden poner de dos formas:
La primera, y más simple, es la de crear nuestro comentario anteponiéndole el caracter # delante del texto. Es decir, si queremos comentar este texto: "Función que redondea", tendríamos que ponerlo así: "# Función que redondea". Aquí un ejemplo de uso de cómo sería un comentario con almohadilla:
" # Hola, estoy comentando en Python "
La segunda manera de realizar un comentario es, igual que la primera, solo que detrás de una sentencia. A veces necesitamos explicar el uso de líneas de código para una mejor comprensión del código. Aquí entra en juego esta forma de comentar código. El funcionamiento es simple, tras la sentencia añadimos el comentario en cuestión al igual que haríamos en el anterior método. Os pongo un ejemplo:
print "Mostramos esto por pantalla" .# sentencia para Mostrar texto en pantalla
Si por el contrario deseamos introducir un comentario de varias líneas, necesitaríamos otro método para realizarlo. No es porque con las almohadillas no se pueda, sino porque la manera que vamos a explicar a continuación es mucho más cómoda de llevar a cabo. Se trata de poner una línea con tres comillas, da igual que sean simples o dobles, después el comentario y, para cerrar, otra línea con tres comillas.
''' Hola, soy un comentario
con varias líneas '''