当前位置：首页 > 行业动态 > 正文

python中怎么注释

在Python中，使用井号（#）进行单行注释，使用三引号（”’或”””）进行多行注释。

在Python中，注释是一种非常重要的编程技巧，它可以帮助程序员理解代码的功能和目的，提高代码的可读性和可维护性，Python中的注释可以分为单行注释和多行注释两种类型。

1、单行注释

单行注释是指在一行中使用井号（）开头的文本，Python解释器会忽略这些文本，不会将其作为代码执行，单行注释通常用于对某一行代码进行简短的解释说明。

这是一个单行注释
print("Hello, World!")   这也是一个单行注释

2、多行注释

多行注释是指在多行中使用三个连续的单引号（”’）或双引号（"""）包围的文本，这种注释可以跨越多行，适用于对代码块进行详细的解释说明。

'''
这是一个多行注释
它可以跨越多行
'''
print("Hello, World!")

或者：

"""
这也是一个多行注释
同样可以跨越多行
"""
print("Hello, World!")

3、文档字符串

文档字符串（docstring）是一种特殊的注释形式，用于描述函数、类或模块的功能和用法，文档字符串通常写在函数、类或模块的定义下方，用三个连续的单引号（”’）或双引号（"""）包围。

def add(a, b):
    '''
    这是一个加法函数
    参数：
    a -第一个加数
    b -第二个加数
    返回值：
    两个加数的和
    '''
    return a + b

或者：

class Person:
    """
    这是一个表示人的类
    包含姓名和年龄两个属性
    """
    def __init__(self, name, age):
        self.name = name
        self.age = age

4、注释规范

为了提高代码的可读性和可维护性，编写注释时应遵循一定的规范：

注释应简洁明了，尽量使用简单的词汇和句子；

注释应与代码紧密相关，避免在代码中添加无关的注释；

对于复杂的代码逻辑，应提供详细的注释说明；

注释应保持最新，随着代码的修改而更新。