Doctring Numpy
Dado que ya sabemos cómo escribir los comentarios multiline, podemos usar las citas triple individuales o las cotizaciones dobles triple. Usamos una cadena de documentación cuando queremos describir nuestras funciones para que podamos obtener la documentación cuando la necesitemos. Algunos IDE le dan documentación simplemente flotando sobre el nombre y algunos resaltan ciertas palabras clave. Pero el hecho es que las documentos en Numpy son mucho más flexibles que en otros idiomas. DOCSTRING es una cadena literal que ocurre al comienzo de la definición de función. Tenemos que proporcionar valores específicos al usar las documentos en casos de funciones, clases, etc.
Al usar documentos con funciones, tenemos que aprobar los argumentos. Al usarlos con clases, pasamos los atributos y métodos. En el caso de los módulos, tenemos que proporcionar una lista de clases y funciones. En el caso del paquete, pasamos la lista de módulos con funcionalidad. Entonces, básicamente, el propósito del documento es, como explica el nombre, que ayuda con la documentación de nuestro código. Hacemos documentación para que si alguien usa nuestro código en el futuro, él pueda comprender nuestro código y la lógica detrás de nuestro código con la ayuda de Docstring. Las funciones incorporadas también tienen documentos en ellas; Podemos usar la función de Help () para ver la documentación de las funciones incorporadas.
Hay algunas diferencias entre comentarios y documentos. Los comentarios son ignorados por los intérpretes, pero las documentos no son ignorados por los intérpretes. La memoria se asigna para las documentos. Un comentario es una descripción del código, pero por otro lado, las documentos nos dicen el propósito del código.
Sintaxis:
La sintaxis para escribir las documentos en Numpy es:
"" "Mensaje de documento" "" "O
"Mensaje de documentos"
Tenga en cuenta que el documento no es una función o método, por lo que no tiene una sintaxis adecuada. Lo único que debe tener en cuenta aquí es que comenzamos el documento con tres citas individuales o tres citas dobles. Escribimos nuestra descripción del código y lo terminamos nuevamente con tres citas individuales o tres cotizaciones dobles al final. No hay nada obligatorio para escribir para las documentos. Solo tiene que poner tres cotizaciones individuales o dobles antes y después de la descripción de su cadena.
Ejemplo 1:
Para comprender los documentos de una mejor manera, realicemos un ejemplo. En este ejemplo, después de incluir la biblioteca Numpy, simplemente declaramos la variable "A" y otra variable "B". Después de eso, creamos nuestro documento que dice "Añadir" A "y" B "variables". En nuestro caso, este es un ejemplo fácil, pero si nuestro código es complejo, esto ayuda mucho al codificador a comprender el código. Después de eso, resumimos las variables "A" y "B" y almacenamos su resultado de salida en otra variable que es "C". Finalmente, imprimimos el valor de la variable "C". Ahora, ejecutamos nuestro código.
importar numpy como npa = 1
b = 2
"Agregamos las variables A y B"
C = A+B
Imprimir (c)
Esta es nuestra salida de la pieza de código dada. Podemos ver que el sistema no ha dado ningún error sobre la sintaxis incorrecta o cualquier cosa para Line7 de nuestro código. Además, el sistema no ha imprimido nuestro documento. En cambio, solo imprimió la salida de nuestra variable "C" en la que le dijimos a nuestro sistema que imprimiera. Esto muestra cómo funcionan los documentos. La próxima vez, cuando un nuevo codificador intente trabajar en nuestro código, comprenderá qué estamos haciendo con la ayuda de nuestro documento. Pero no se imprimirá como salida, por lo que el usuario del código no será perturbado por él.
Ejemplo 2:
Ahora, realizamos un ejemplo complejo para comprender el funcionamiento de Docstring. Primero, incluimos la biblioteca Numpy y luego escribimos una cadena de documentos en la que explicamos la siguiente línea de código donde explicamos la inicialización de la matriz. También agregamos las documentos en la otra parte del código. Ahora, si compartimos este código con cualquier nuevo desarrollador de Python sin agregar las documentos, de alguna manera será difícil para él conocer el trabajo y el propósito de este código. Primero tiene que buscar sobre las funciones que utilizamos. Pero si agregamos un documento a nuestro código, será fácil para los otros desarrolladores comprender el código sin estudiar más sobre las funciones. No estamos restringidos a agregar comentarios a algunos límites; Los comentarios pueden ser de una o más de una línea. También se puede agregar más de una vez en un código. Entonces, importe numpy como np.
"Creación de la variable a la que pasaremos una matriz de tamaño 1x6"matriz = np.Array ([11, 22, 33, 44, 55, 66])
"Asignar la matriz a la función tofile () para dejarla guardar en el archivo llamado ARR"
formación.tofile ("arr.papelera")
"Muestre el archivo usando la función fromfile"
Imprimir (NP.fromfile ("arr.bin ", dtype = int))
Como se muestra en el siguiente fragmento, las documentos no se muestran en la salida, lo que significa que no afecta la salida o la compilación del código. Los documentos se ignoran durante el proceso de compilación.
Conclusión
En esta guía, aprendimos sobre las documentos en Numpy. Comparamos los documentos con comentarios y explicamos la diferencia entre ambos. Aprendimos la sintaxis de las documentos y cómo escribir las documentos en nuestro código. Además, también tratamos de explicar cuáles son las documentos en Numpy y cómo funcionan con la ayuda de ejemplos. Finalmente, comentamos que son esenciales para los codificadores. No repetiremos la importancia de las documentos en Numpy. Solo diremos que debe usar las documentos en su código. En Numpy, el estilo de escritura de los documentos es el más popular. Se usa ampliamente en la comunidad de programación para informar mutuamente sobre el trabajo y la funcionalidad de sus códigos. Esta guía lo ayudará a comenzar con las documentos numpy. Intentamos cubrir la mayor parte de lo que necesitará usando las documentos en Numpy.