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 Pythonpull/26631/head^2
parent
f6167f58ab
commit
d8bc578055
|
@ -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:
|
||||
|
||||
```python
|
||||
# This is a block comment.
|
||||
print('Hello world!') # This is an inline commment.
|
||||
# Esto es un bloque de comentarios.
|
||||
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
|
||||
# This is the first line of a multiline comment.
|
||||
# This is the second line.
|
||||
# Este es la primer linea de un comentario multinlinea.
|
||||
# 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__` .
|
||||
|
@ -24,15 +24,15 @@ Para que una cadena literal sea una cadena de documentación, debe comenzar y te
|
|||
|
||||
```python
|
||||
class SomeClass():
|
||||
"""Summary line for SomeClass.
|
||||
"""Linea de resumen que explica una clase.
|
||||
|
||||
More elaborate descriptions may require using a
|
||||
a multiline docstring.
|
||||
Descripciones más elaborada puede requerir usar un docstring
|
||||
multilinea.
|
||||
"""
|
||||
|
||||
def method_a(self):
|
||||
"""Single line summary of method_a."""
|
||||
"""Comentario de una linea del method_a."""
|
||||
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) .
|
||||
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) .
|
||||
|
|
Loading…
Reference in New Issue