Python 中使用以下符号标识注释:
一、单行注释
-
符号 :井号
#
-
用法 :在代码行前添加
#
,其后的内容会被解释器忽略。- 示例 :
# 这是一个单行注释
print("Hello, World!") # 另一个单行注释
这是一个单行注释
print("Hello, World!") # 另一个单行注释
二、多行注释
-
符号 :三个单引号
'''
或三个双引号"""
-
用法 :用成对的三引号包裹多行内容,通常用于函数、类或模块的文档说明。- 示例 :
三、注意事项
- 注释位置 :
-
单行注释可出现在代码行任意位置,但通常放在行首或函数/类定义上方。
-
多行注释通常作为文档字符串,与函数/类定义同步。2. 特殊场景 :
-
文件开头使用
#!/usr/bin/python
指定解释器(如脚本文件)。 -
编码声明使用
# -*- coding: UTF-8 -*-
(单行)。
- 作用 :
- 注释用于解释代码逻辑、临时禁用代码块或辅助调试。
四、常见误区
- 多行注释与文档字符串 :
虽然多行注释可以用三引号包裹,但函数/类的官方文档应使用文档字符串(即 def
语句后的三引号)。- 注释与文档的区别 :
注释是开发者添加的说明,而文档字符串是代码自带的说明,需通过 help()
函数查看。
通过合理使用注释符号,可以提高代码可读性和可维护性。