Comentar el código
Cuestiones introductorias
Siempre es una buena práctica comentar el código, lo cual debe hacerse de forma breve y lo más precisa posible. Para comentar el código contamos en Python con un símbolo específico.
La almohadilla (#) es el símbolo usado en Python para introducir comentarios, aunque condicionado a que éstos sean de una línea.
Estos comentarios se pueden hacer en líneas independiente # Este es un comentario de línea independiente que podemos usar también tras el código, en la misma línea >>> a + b = c # Comentario de la línea de código o simulando comentarios de varias líneas...
>>> # Comentario línea 1
>>> # Comentario línea 2
Otra forma de comentar el código (esta vez por bloques de varias líneas) es usando ''' como inicio y de nuevo ''' como fin.
En ambos caso se espera que los comentarios, además de pertinentes deben, ser breves, ya que se trata de informar del funcionamiento del algoritmo y sus sentencias, pero no de dar largas explicaciones sobre lo que hace el código o informar sobre los motivos de la expresión de las instrucciones.
No hay comentarios:
Publicar un comentario
Comenta esta entrada