Python 注释作用写法及示例代码

1､代码注释的作用

注释是对一段代码的解释和说明，可提高程序代码的可读性，让人们能够更加轻松地了解代码，尤其在大型项目开发和团队项目中，注释是必不可少的。注释了测试代码就以阻止执行。

2､单行注释

单行注释以＃开头，单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或者表达式之后：

例如，

#这是注释内容
print("Hello, World!")

注释放在一行的末尾，Python不会执行#号后的代码：

例如，

print("Hello, World!") #这是注释内容

注释不需要执行的代码，代码就不会执行：

例如，

#print("Hello, World!")
print("Hello, cjavapy!")

3､多行注释

Python没有多行注释的语法。Python中多行注释使用三个单引号（'''）或者三个双引号（"""）来标记，而实际上这是多行字符串的书写方式，并不是Python本身提倡的多行注释方法。

要添加多行注释，可以#为每行插入一个：

例如，

#代码是用于
#打印输出字符串
#多于一行的注释
print("Hello, World!")

由于Python会忽略未分配给变量的字符串文字，则可以在代码中添加多行字符串（三引号），并将注释放入其中：

例如，

"""
三引号可以
用作多行的注释
多于一行的注释
"""
print("Hello, World!")

只要没有将字符串分配给变量，就是多行注释了。

4、文档字符串（docstring）

使用三个双引号 """ 进行文档字符串注释，通常用于函数、类或模块的说明。

def greet(name):
    """
    这个函数用来问候某个人
    参数:
        name (str): 被问候的人的名字
    返回:
        str: 返回问候语
    """
    return f"Hello, {name}!"

class Person:
    """
    这个类表示一个人
    属性:
        name (str): 这个人的名字
    方法:
        greet(): 问候这个人
    """
    def __init__(self, name):
        """
        初始化方法
        参数:
            name (str): 这个人的名字
        """
        self.name = name

    def greet(self):
        """
        问候方法
        返回:
            str: 返回问候语
        """
        return f"Hello, {self.name}!"

# 使用文档字符串可以通过内置的 help() 函数查看
help(greet)
help(Person)