Inmersión en Python Inmersión en Python - iPereda

2.3. Documentación de funciones
Puede documentar una función en Python proporcionando una cadena de
documentación.
Ejemplo 2.2. Definición de la cadena de documentación de la
función buildConnectionString
def buildConnectionString(params):
"""Crea una cadena de conexión partiendo de un diccionario de
parámetros.
Devuelve una cadena."""
Las comillas triples implican una cadena multilínea. Todo lo que haya entre el
principio y el final de las comillas es parte de una sola cadena, incluyendo los
retornos de carro y otros comillas. Puede usarlas para definir cualquier cadena,
pero donde las verá más a menudo es haciendo de cadena de documentación.
Las comillas triples también son una manera sencilla de definir una cadena
que contenga comillas tanto simples como dobles, como qq/.../ en Perl.
Todo lo que hay entre las comillas triples es la cadena de documentación de la
función, y se usa para explicar lo que hace la función. En caso de que exista una
cadena de documentación, debe ser la primera cosa definida en una función
(esto es, lo primero tras los dos puntos). Técnicamente, no necesita dotar a su
función de una cadena de documentación, pero debería hacerlo siempre. Sé que
habrá escuchado esto en toda clase de programación a la que haya asistido
alguna vez, pero Python le da un incentivo añadido: la cadena de
documentación está disponible en tiempo de ejecución como atributo de la
función.