Ejemplo de documentos de Python
Si bien los comentarios se utilizan para programas, declaraciones y expresiones, que generalmente son breves, los documentos son excelentes para comprender el funcionamiento de la parte más grande del script, como el uso general de cualquier módulo, clase o función. Son una descripción de una línea de código o declaración producida por un programador que generalmente es para comprender lo que hace. Es crucial documentar su código correctamente si desea escribir programas con código claro y buena documentación. Se suministran las documentos, empleando las "citas triple individuales" o "citas dobles triple" justo después de la definición de función, clase o método.
Ejemplo 1: Programa de citas de triple de python Docstring Triple
O el método __doc__ del objeto o la función de ayuda se pueden usar para obtener las documentos. La declaración y el uso de un documento con las cotizaciones triple individuales se muestran en los siguientes ejemplos:
Comience con definir una función en Python. Creamos una función como my_func (). Dentro del cuerpo del my_func, tenemos como un documento envuelto alrededor de las citas triple individuales. Luego, al final de la función, ejecutamos explícitamente la instrucción de retorno que devuelve el valor de ninguno. La función de impresión toma my_func con el objeto _doc_ que mostrará el documento. Además, tenemos una función de ayuda de Python que se utiliza para imprimir la documentación de la función my_func.
Cuando este programa en particular es depurado y ejecutado, genera los siguientes resultados en la pantalla de la consola de Spyder:
Ejemplo 2: Programa de citas dobles triples de Python Docstring
El siguiente código implementa la declaración de documentos y usa con los triples quotas:
Aquí, damos un nombre de función my_func2. Dentro del cuerpo del my_func2, declaramos un documento con la cita triple-doble. Luego, llamamos al objeto _doc_ de Python para imprimir el documento especificado y la documentación de la función my_func2 con la función de ayuda.
Los resultados generados a partir de los códigos mencionados son los siguientes. Esta salida se genera mediante la ejecución del código fijo anterior en Spyder:
Ejemplo 3: Programa de documentos de una línea de Python
Los documentos de una línea son justo lo que su nombre sugiere: una línea. Están empleados en situaciones descaradas. Las últimas citas están situadas en una línea similar a las iniciales. Para las frases, esto parece más atractivo.
Aquí, construimos una función como "agregar" que toma dos argumentos: x e y. Luego, declaramos el documento de una línea dentro del cuerpo de la definición de la función "Agregar". La declaración de retorno devuelve el valor de la adición de los dos valores. Se invoca la instrucción de impresión para mostrar el documento dentro de la función Agregar utilizando el objeto _doc_.
Los resultados de la documentación de una línea se muestran en la siguiente pantalla de consola de Spyder. Esta salida se genera mediante la ejecución del código fijo anterior en Spyder:
Ejemplo 4: Programa de un documento de múltiples líneas de Python
Similar a las documentos de una línea, las documentos de varias líneas comienzan con una línea de resumen y terminan con una línea en blanco antes de describir algo con mayor detalle. La línea de resumen puede aparecer en una línea similar a las citas iniciales o en una línea diferente. En la siguiente instancia se demuestra un documento multiline:
En este script de ejemplo particular, tenemos la definición de función que se le da un nombre como python_function. Esta función toma un valor de argumento x. El cuerpo de la función se declara con la cadena de múltiples líneas, que es la descripción del valor del argumento y el tipo de datos int. Después de eso, se define el comando de retorno. El documento multiline se muestra llamando al objeto _doc_ dentro de la función de impresión.
Las múltiples líneas de la documentación se imprimen en el terminal Spyder de la siguiente manera:
Ejemplo 5: Programa de muescas de documentos de Python
Las citas en su línea inicial se sangran la misma cantidad que el resto de la documentación. Cada sangría en la primera línea de Docstring (con la primera nueva línea) es innecesaria y debe eliminarse. Posteriormente, las líneas en el documento mantienen su indentación relativa. Como ilustración sobre cómo crear las documentos para una clase y sus métodos, veamos un ejemplo. El acceso al documento es a través de la ayuda:
Definimos una clase con la clase de palabras clave y el nombre de esa clase como my_python_example. Dentro de la clase my_python_example, declaramos el documento que está rodeado por los triples quotas dobles. Luego, creamos el cuadrado de funciones que tiene la entrada x y la función también se declara con el documento. Luego, creamos otra función con el nombre, cubo. También toma una entrada n. Esta función se crea para el cubo del número. Esta declaración se explica por la declaración de documentos. Después de eso, tenemos una función de ayuda de Python para ejecutar la documentación de la clase my_python_program y el cuadrado de la función.
Del programa Python mencionado anteriormente, se obtiene el siguiente resultado enumerado. Esta salida se genera mediante la ejecución del código previamente fijo en Spyder:
Conclusión
El objetivo principal de este curso es familiarizarlo con las documentos atravesando las ideas fundamentales. Sin embargo, debido a que las documentos son un tema tan amplio, es posible que algunas ideas se saltaran. Para obtener la documentación de una función, use la función Help (). Coloque una cadena, ya sea una cadena de una sola línea o una cadena de múltiples líneas, en la primera línea de la función para agregar la documentación.