Comentar el código
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 (1).
Estos comentarios se pueden hacer en líneas independiente...
>>> # Este es un comentario de línea independiente
... 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
En cualquiera de los casos, los comentarios, a la vez que necesarios, deben ser breves y pertinentes, ya que se trata de informar del funcionamiento del algoritmo y sus sentencias, pero no de que los comentarios sean largas explicaciones sobre lo que hace el código o por los motivos de la forma en que se expresan las instrucciones. Si breve, dos veces bueno.
NOTA
(1) En los manuales consultados se afirma que se pueden usar las triples comillas simples (''') para comentarios de varias líneas, pero en mi experiencia no funcionan como es de esperar, devolviendo el intérprete el texto escrito entre comillas simples.
No hay comentarios:
Publicar un comentario
Comenta esta entrada