Python添加注释主要有以下两种方式,结合使用可提升代码可读性:
一、单行注释
使用 #
符号,适用于解释单行代码或关键逻辑。例如:
# 这是一个单行注释
x = 5 # 赋值操作
快捷添加方法 :在编辑器中选中代码后按 Ctrl+/
快捷键。
二、多行注释
-
文档字符串(Docstrings)
用于函数、类或模块的说明,支持参数、返回值等描述。例如:
def add(a, b): """计算两个数的和 参数: a (int/float): 第一个加数 b (int/float): 第二个加数 返回: int/float: 两数之和 """ return a + b
自动生成工具 :使用
pydocstring
库可自动生成规范注释模板。 -
多行文本注释
使用三个单引号
'''
或三个双引号"""
括起来,适用于代码块说明。例如:''' 这是一个多行注释,可跨越多行 用于解释复杂逻辑 '''
三、注意事项
-
规范使用 :注释应简洁明了,避免冗长。函数或复杂逻辑前建议添加说明性注释。
-
工具辅助 :结合
pydocstring
等工具,可提升注释规范性和效率。 -
Excel扩展 :通过
openpyxl
库,可在Excel文件中为单元格添加注释。