examples - python plotly axis
Triple-doble cita vs Doble cita (3)
¿Cuál es la forma preferida de escribir la cadena doc de Python?
""" o "
En el libro Dive Into Python , el autor proporciona el siguiente ejemplo:
def buildConnectionString(params):
"""Build a connection string from a dictionary of parameters.
Returns string."""
En otro chapter , el autor proporciona otro ejemplo:
def stripnulls(data):
"strip whitespace and nulls"
return data.replace("/00", "").strip()
Ambos trabajos de sintaxis. La única diferencia para mí es que """ nos permite escribir documentos de varias líneas.
¿Hay alguna diferencia aparte de eso?
Ambas son cadenas, así que no hay diferencia. El estilo preferido es las comillas dobles triples ( PEP 257 ):
Para mantener la coherencia, siempre use
"""triple double quotes"""alrededor de las cadenas de documentación.Use
r"""raw triple double quotes"""si usa alguna barra invertida en sus cadenas de documentación. Para las cadenas de documentación de Unicode, useu"""Unicode triple-quoted strings""".
De la guía de estilo PEP8 :
PEP 257 describe buenas convenciones de docstring. Tenga en cuenta que lo más importante es que la "" "que termina una cadena de documentos multilínea debe estar sola en una línea, por ejemplo:
"""Return a foobang Optional plotz says to frobnicate the bizbaz first. """Para las cadenas de documentos de una línea, está bien mantener el "" "cierre en la misma línea.
PEP 257 recomienda utilizar comillas triples, incluso para cadenas de documentación de una línea:
- Las comillas triples se utilizan aunque la cadena encaja en una línea. Esto facilita su posterior expansión.
Tenga en cuenta que ni siquiera la biblioteca estándar de Python sigue estas recomendaciones constantemente. Por ejemplo,
No en realidad no. Si está escribiendo en un archivo, el uso de comillas triples puede ser ideal, ya que no tiene que usar "/ n" para ir hacia abajo. Solo asegúrese de que las citas con las que comience y termine sean del mismo tipo (comillas dobles o triples). Aquí tiene un recurso confiable si tiene más preguntas: