freeCodeCamp/guide/spanish/python/commenting-code/index.md

39 lines
2.2 KiB
Markdown
Raw Normal View History

2018-10-12 19:37:13 +00:00
---
title: Python Commenting Code
localeTitle: Código de comentarios de Python
---
Los comentarios se utilizan para anotar, describir o explicar códigos que son complejos o difíciles de entender. Python ignorará intencionalmente los comentarios cuando compile el bytecode por el intérprete. [`PEP 8`](https://www.python.org/dev/peps/pep-0008/#comments) tiene una sección que trata con los comentarios. También aumentan la legibilidad del código al agregar un lenguaje fácil y descriptivo para una mejor comprensión.
**Los** comentarios **en** **bloque** y en **línea** comienzan con un `#` , seguido de un espacio antes del comentario:
```python
# Esto es un bloque de comentarios.
print('Hello world!') # Este un comentario de una sola linea .
2018-10-12 19:37:13 +00:00
```
Python no incluye una forma formal de escribir comentarios de varias líneas. Cada línea de un comentario que abarca varias líneas debe comenzar con `#` y un espacio:
```python
# Este es la primer linea de un comentario multinlinea.
# Esta es la segunda linea.
2018-10-12 19:37:13 +00:00
```
Otro tipo de comentario es el **docstring** , documentado en [`PEP 257`](https://www.python.org/dev/peps/pep-0257/) . Las cadenas de texto son un tipo específico de comentario que se convierte en el atributo `__doc__` .
Para que una cadena literal sea una cadena de documentación, debe comenzar y terminar con `\"\"\"` y ser la primera declaración del módulo, función, clase o definición de método que está documentando:
```python
class SomeClass():
"""Linea de resumen que explica una clase.
2018-10-12 19:37:13 +00:00
Descripciones más elaborada puede requerir usar un docstring
multilinea.
2018-10-12 19:37:13 +00:00
"""
def method_a(self):
"""Comentario de una linea del method_a."""
2018-10-12 19:37:13 +00:00
pass
```
Los literales de cadena que comienzan y terminan con `"""` que no son cadenas de documentación (no la primera instrucción), se pueden usar para cadenas de `__doc__` . No se convertirán en atributos `__doc__` . Si no están asignados a una variable, no generarán un `__doc__` . Hay una discusión sobre su uso como comentarios de varias líneas que se encuentran [aquí](http://stackoverflow.com/questions/7696924/multiline-comments-in-python) .