COMO ESCRIBIR COMENTARIOS EN PYTHON

 

Comentarios

Los comentarios son anotaciones que podemos incluir en nuestro programa y que nos permiten aclarar ciertos aspectos del código. Estas indicaciones son ignoradas por el intérprete de Python.

Los comentarios se incluyen usando el símbolo almohadilla # y comprenden hasta el final de la línea.

Comentario en bloque
# Universe age expressed in days
universe_age = 13800 * (10 ** 6) * 365

Los comentarios también pueden aparecer en la misma línea de código, aunque la guía de estilo de Python no aconseja usarlos en demasía:

Comentario en línea
stock = 0   # Release additional articles

Reglas para escribir buenos comentarios: [6]

  1. Los comentarios no deberían duplicar el código.

  2. Los buenos comentarios no arreglan un código poco claro.

  3. Si no puedes escribir un comentario claro, puede haber un problema en el código.

  4. Los comentarios deberían evitar la confusión, no crearla.

  5. Usa comentarios para explicar código no idiomático.

  6. Proporciona enlaces a la fuente original del código copiado.

  7. Incluye enlaces a referencias externas que sean de ayuda.

  8. Añade comentarios cuando arregles errores.

  9. Usa comentarios para destacar implementaciones incompletas.

Comentarios

Publicar un comentario

Entradas más populares de este blog

PySDR: una guía para SDR y DSP usando Python by Dr. Marc Lichtman. Introducciòn.

Imagen
 Fuente: https://pysdr.org/content/intro.html     1. Introduction Propósito y público objetivo Primero y más importante, un par de términos importantes: Radio definida por software (SDR): Como concepto , se refiere al uso de software para realizar tareas de procesamiento de señales que tradicionalmente se realizaban mediante hardware, específico para aplicaciones de radio/RF. Este software se puede ejecutar en una computadora de uso general (CPU), FPGA o incluso GPU, y se puede usar para aplicaciones en tiempo real o procesamiento fuera de línea de señales grabadas. Términos análogos incluyen “radio software” y “procesamiento de señales digitales de RF”. Como cosa (p. ej., “un SDR”), normalmente se refiere a un dispositivo al que se puede conectar una antena y recibir señales de RF, y las muestras de RF digitalizadas se envían a una computadora para su procesamiento o grabación (p. ej., a través de USB, Ethernet , PCI). Muchos SDR también tienen capacidades de transmi
Leer más

Colecciones de datos/set

>> # Un conjunto o set es una colección de datos encerrados entre llaves y separados por comas. >> set1 = {1,2,3} >> # los elementos de un set no se pueden recorrer por medio de indices. >> set1[0] >> # Error >> # Un set es mutable, se le pueden agregar o remover elementos >> set1.add(4) >> {1,2,3,4} >> set1.remove(4) >> {1,2,3} >> set1.update([4,5,6]) >> {1,2,3,4,5,6}
Leer más