Hola a todos, Xiaobian responderá las preguntas sobre el código y el uso de python. Mucha gente no conoce el código de programación básico de python, ¡echemos un vistazo ahora!
El contenido de este artículo presenta principalmente el análisis de ejemplos de código de especificación de comentarios de código Python. La introducción del código de muestra es muy detallada. Tiene un cierto valor de aprendizaje de referencia para el estudio o el trabajo de todos. ¡Los amigos que lo necesiten pueden consultarlo! ! !
1. Introducción a los comentarios de código
Los comentarios son explicaciones y descripciones del código, cuyo propósito es facilitar la comprensión del código por parte de las personas.
Un comentario es una explicación o sugerencia dada por el escritor del programa a una declaración, segmento de programa, función, etc. al escribir un programa, que puede mejorar la legibilidad del código del programa.
En el código con lógica de procesamiento, la cantidad efectiva de comentarios del programa fuente debe ser superior al 20 %.
2. Clasificación de los comentarios del código
Comentario de línea: la línea después del símbolo no se compilará (se mostrará)
Comentario de bloque: la parte en el medio del símbolo de comentario de bloque no se compilará
3. Conceptos básicos de los comentarios del código Python
Python usa # para representar comentarios de una sola línea. Los comentarios de una sola línea se pueden colocar como una sola línea encima de la línea de código comentada, o después de una declaración o expresión. Por ejemplo:
nombre = 'xiaohong' # comentario de una sola línea
# Nombre de comentario de una sola línea = 'xiaohong'
Python usa tres comillas simples o tres comillas dobles para indicar comentarios de varias líneas. Se utiliza cuando hay demasiados comentarios para escribir, como en el siguiente ejemplo:
'''Este es un comentario de varias líneas usando tres comillas simples'''
"""Este es un comentario de varias líneas que usa comillas dobles triples"""
4. Introducción y uso de DocStrings
4.1 Introducción a DocStrings
cadena de documentación
Es una herramienta importante para explicar los programas de documentación y ayudar a que la documentación de su programa sea más fácil de entender.
4.2 Usando DocStrings en python
Use un par de tres comillas simples ''' o un par de tres comillas dobles """ en la primera línea del cuerpo de la función para definir la cadena del documento. Puede usar doc (tenga en cuenta el guión bajo doble) para llamar al atributo de la cadena del documento en la funcion
Escriba un ejemplo de la siguiente manera:
5.2 estilo Google
5.3 Numpydoc (estilo Numpy)
Seis, algo de experiencia en anotaciones.
Los comentarios no siempre son mejores. Para el código que se explica por sí mismo, no es necesario agregar comentarios.
Para operaciones complejas, los comentarios correspondientes deben escribirse antes de que comience la operación.
Para el código que no se explica por sí mismo, se deben agregar comentarios después del código.
Nunca describa el código. Generalmente, las personas que leen el código entienden la sintaxis de Python, pero no saben lo que hace el código.