Python注释是代码中不可或缺的说明性文本,常见的四种注释包括单行注释(#
)、多行注释(三引号'''
或"""
)、文档字符串(Docstring)以及行末注释。 它们分别用于简短说明、多行描述、函数/模块文档以及代码行尾的补充解释,能显著提升代码可读性和维护性。
-
单行注释
以#
开头,适用于简短说明或临时禁用代码。例如:# 计算用户年龄 age = 25
-
多行注释
用三引号包裹,通常用于描述复杂逻辑或临时注释大段代码。例如:''' 该函数用于处理用户输入, 包括验证格式和过滤敏感词。 '''
-
文档字符串(Docstring)
位于函数、类或模块开头,用三引号定义,可通过help()
查看。例如:def add(a, b): """返回两个数字的和""" return a + b
-
行末注释
在代码行末尾添加#
说明,需注意控制长度避免混乱。例如:total = price * quantity # 计算总价,含税
合理使用注释能帮助团队协作和后期维护,但需避免过度注释或描述与代码无关的内容。关键逻辑和复杂算法是注释的重点应用场景。