Conceptos Básicos de Python (Parte 1)

Posted on

Python Es Sobre Legibilidad

 

Los comentarios deberían responder por qué mientras que el código debería responder cómo.

Con toda honestidad, si siente la necesidad de comentar su código, debería empezar por re-escribir su código por legibilidad. Después de re-escribirlo, si continua sintiendo la necesidad, coméntelo. Comentarios buenos explica,

  • suposiciones
  • decisiones importantes
  • detalles importantes
  • problemas que trata de resolver
  • problemas que trata de superar en su programa.

Todas las funciones que haya creado deberían tener cadenas de documentación (es decir, docstrings). Eso debería ser después de definir la función. Eso se hace encerrando la cadena con triple comillas. Para llamar un docstring de código, use nombre_función.__doc__ y para llamar uno interactivamente, use help(nombre_función).

def nombre_función(arg1, arg2):

“””Una función llamada nombre_función que toma dos argumentos.”””

Espacios en blanco (es decir whitespace) ayudan a la legibilidad, pero también, es importante por otra razón. Si una línea física comienza con espacios, es un sangrado (o indentado). Un sangrado identifica bloques de código. Cuando sangre el código, no mezcle tabs y espacios.

Por legibilidad, es una práctica común tener 80 caracteres por línea.

 

Nota del Autor: Parte 2 saldrá mañana.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *