Se traducen algunas partes del documento sobre hacer comentarios en Python (#26035)

Se traducen partes de los códigos del ejemplo dados para explicar como comentar en Python
This commit is contained in:
danielrs975
2019-08-12 12:02:07 -04:00
committed by Randell Dawson
parent f6167f58ab
commit d8bc578055

View File

@ -7,15 +7,15 @@ Los comentarios se utilizan para anotar, describir o explicar códigos que son c
**Los** comentarios **en** **bloque** y en **línea** comienzan con un `#` , seguido de un espacio antes del comentario: **Los** comentarios **en** **bloque** y en **línea** comienzan con un `#` , seguido de un espacio antes del comentario:
```python ```python
# This is a block comment. # Esto es un bloque de comentarios.
print('Hello world!') # This is an inline commment. print('Hello world!') # Este un comentario de una sola linea .
``` ```
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 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 ```python
# This is the first line of a multiline comment. # Este es la primer linea de un comentario multinlinea.
# This is the second line. # Esta es la segunda linea.
``` ```
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__` . 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__` .
@ -24,14 +24,14 @@ Para que una cadena literal sea una cadena de documentación, debe comenzar y te
```python ```python
class SomeClass(): class SomeClass():
"""Summary line for SomeClass. """Linea de resumen que explica una clase.
More elaborate descriptions may require using a Descripciones más elaborada puede requerir usar un docstring
a multiline docstring. multilinea.
""" """
def method_a(self): def method_a(self):
"""Single line summary of method_a.""" """Comentario de una linea del method_a."""
pass pass
``` ```