Uso detallado de comentarios (comentarios de varias líneas y comentarios de una sola línea) en Python

Tabla de contenido

Comentarios de una sola línea de Python

Comentarios de varias líneas de Python

Precauciones

Los comentarios pueden ayudar a depurar programas


Los comentarios (Comentarios) se utilizan para indicar o explicar el rol y la función de algún código al usuario, y pueden aparecer en cualquier parte del código. El intérprete de Python ignora el comentario al ejecutar el código y no hace nada como si no existiera.
En el proceso de depuración (Depuración) de programas, los comentarios también se pueden usar para eliminar temporalmente código inútil.
La función más importante de los comentarios es mejorar la legibilidad del programa. ¡Un programa sin comentarios es simplemente un libro, que hace que la gente vomite sangre!
No creas que la especificación del código que escribes puede quedar sin comentarios. Darle a otra persona un fragmento de código sin comentarios es una falta de respeto hacia los demás y un comportamiento muy egoísta; puede gustarte abusar de ti mismo, pero por favor no abuses de los demás.
Muchos programadores prefieren desarrollar una aplicación por sí mismos que modificar el código de otras personas, la falta de comentarios razonables es una razón importante. Aunque un buen código se puede documentar por sí mismo, nunca sabremos quién está leyendo este código en el futuro y si tiene la misma idea que usted; o después de un período de tiempo, usted mismo no sabrá el propósito de escribir este código. en ese momento arriba.
En general, los comentarios de código razonables deben representar aproximadamente 1/3 del código fuente.
Python admite dos tipos de comentarios, comentarios de una sola línea y comentarios de varias líneas.

Comentarios de una sola línea de Python

Python usa el signo de libra #como símbolo para comentarios de una sola línea, y el formato de sintaxis es

# Contenido del comentario

#Todo , desde el signo de libra hasta el final de la línea, es un comentario. Cuando lo encuentra el intérprete de Python #, se ignora toda la línea siguiente.
Al explicar la función de varias líneas de código, el comentario generalmente se coloca en la línea anterior del código, por ejemplo: 

#使用print输出字符串
print("Hello World!")
#使用 print输出数字
print(100)
print( 3 + 100 * 2)
print( (3 + 100) * 2 )

Cuando se explica la función de una sola línea de código, los comentarios generalmente se colocan en el lado derecho del código, por ejemplo:

print( 36.7 * 14.5 )  #输出乘积
print( 100 % 7 )  #输出余数

Comentarios de varias líneas de Python

Un comentario de varias líneas hace referencia al contenido de varias líneas (incluida una línea) en un programa de comentarios de una sola vez.

Python usa tres comillas simples consecutivas ''' o tres comillas dobles consecutivas """ para comentar el contenido de varias líneas. El formato específico es el siguiente:

'''
使用 3 个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
'''

o

"""
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
"""

Los comentarios de varias líneas generalmente se usan para agregar información de descripción funcional o de derechos de autor a los archivos, módulos, clases o funciones de Python.

Precauciones

1) Los comentarios de varias líneas de Python no admiten el anidamiento, por lo que la siguiente escritura es incorrecta:

'''
外层注释
    '''
    内层注释
    '''
'''

2) Independientemente de si se trata de un comentario de varias líneas o de una sola línea, cuando los caracteres de comentario aparecen como parte de una cadena, ya no pueden considerarse marcas de comentario, sino que deben considerarse como parte del código normal, por ejemplo:

print('''Hello,World!''')
print("#是单行注释的开始")

resultado de la operación:

¡Hola, mundo!
# es el comienzo de un comentario de una sola línea

Para las dos primeras líneas de código, Python no trata las tres comillas aquí como comentarios de varias líneas, sino como el principio y el final de la cadena.

Para la tercera línea de código, Python no trata el signo de libra como un comentario de una sola línea, sino como parte de la cadena.

Los comentarios pueden ayudar a depurar programas

Agregar instrucciones al código es la función básica de los comentarios, además tiene otra función práctica, que se utiliza para depurar programas.

Por ejemplo, si cree que puede haber un problema con cierta parte del código, puede comentar este código primero, dejar que el intérprete de Python ignore este código y luego ejecutarlo. Si el programa se puede ejecutar normalmente, se puede explicar que el error es causado por este código; por el contrario, si el mismo error todavía ocurre, se puede explicar que el error no es causado por este código.

El uso de comentarios en el proceso de depuración de programas puede reducir el alcance de los errores y mejorar la eficiencia de los programas de depuración. 

Supongo que te gusta

Origin blog.csdn.net/qq_34274756/article/details/131031165
Recomendado
Clasificación