【0006】Python注释详解_代码注释掉是什么意思-CSDN博客

本文链接：https://blog.csdn.net/cxyzxc0325/article/details/145992454

如果你觉得我的文章写的不错，请关注我哟，请点赞、评论，收藏此文章，谢谢！

本文内容体系结构如下：
在这里插入图片描述

本文将详细讲解Python中的注释。注释是编程中的重要元素，它不仅能够帮助开发者理解代码，还能记录开发思路、促进团队协作。通过文，你将全面掌握如何在Python代码中添加注释，以及注释的最佳实践。

一、什么是注释

注释是代码中不被执行的文本，用于解释代码的功能、目的或逻辑。在Python中，注释以特定的符号开头，告诉解释器忽略这些文本。注释对于提高代码的可读性和可维护性至关重要。

有个故事是这样说的：有个程序员拿到了一段代码，代码比较长，逻辑性也比较强，但是没有注释，越看越难以理解，越看越烦躁，心里就开始“问候”这个代码的作者了：”这是哪个缺德玩意写的代码，一点注释都没有，让人怎么看？怎么用？还有没有一点职业道德了，啊~~~~“。耐着脾气往下看，越往下看越觉得代码好像自己写的，看到最后，发现还真是自己的写的…要是当时写代码时写上注释，现在也不至于这么费力了啊，由此可见，注释的重要性。

二、为什么需要注释

（1）提高可读性

注释可以帮助其他开发者（或未来的你）快速理解代码的功能和逻辑。
特别是对于复杂的算法或逻辑，注释能够清晰地解释每一步的操作。

（2）记录思路

在开发过程中，注释可以记录你的思考过程和决策，有助于后续的维护和修改。
当你回顾代码时，注释能够帮助你快速找回当时的开发思路。

（3）协作开发

在团队开发中，注释是沟通代码意图和细节的重要手段。
通过注释，团队成员可以更容易地理解彼此的代码，减少沟通成本。

（4）调试和测试

有时，注释可以用于临时禁用某段代码，以便进行调试和测试。
通过注释掉某段代码，你可以逐一排查问题，找到错误的根源。

三、Python中的注释类型

3.1 单行注释

（1）语法规则

单行注释以井号（#）开头。
井号后面的所有文本都被视为注释，直到行尾。
注释可以位于代码行的任何位置，但通常放在代码行的上方或右侧。
一般#和注释内容中间空1个空格，规范！

（2）使用场景

解释单行代码的功能或目的。
标记临时禁用的代码段。
为复杂的逻辑或算法提供简短的说明。

（3）代码演示

# 打印“Hello, World!”到控制台
print("Hello, World!")  # 这是一个简单的打印语句

# 计算两个数的和，并打印结果
a = 5  # 定义变量a，赋值为5
b = 3  # 定义变量b，赋值为3
sum = a + b  # 计算a和b的和，并将结果赋值给sum
print(sum)  # 打印sum的值

代码执行结果如下：
在这里插入图片描述

3.2 多行注释

Python没有直接的多行注释语法（像其他语言中的/* ... */），但是可以通过一些方法来模拟多行注释。

（1）模拟多行注释的方法

可以通过连续的单行注释来模拟多行注释。
也可以使用三引号（'''或"""）来定义多行字符串，虽然这在技术上是字符串，但如果不被赋值给变量或用于其他目的，它可以作为多行注释来使用。

（2）使用注意事项

使用三引号作为多行注释时，要确保它们不被赋值给任何变量或用于其他字符串操作。
多行注释通常用于解释较长的代码段或复杂的逻辑。

（3）代码演示

# 这是一个多行注释的模拟
# 使用连续的单行注释来解释下面的代码段
# 下面的代码计算一个矩形的面积和周长

'''
这是一个多行字符串，
但也可以被用作多行注释。
注意：三引号内的内容在技术上是一个字符串，
但如果不使用它（即不赋值给变量或用于其他目的），
它就可以作为注释。
'''

"""
多行注释推荐使用三个双引号，不要使用三个三引号
这是规范
"""

# 矩形的长和宽
length = 10  # 定义变量length，赋值为10
width = 5    # 定义变量width，赋值为5

# 计算面积
area = length * width  # 面积 = 长 * 宽

#计算周长
perimeter = 2 * (length + width)  # 周长 = 2 * (长 + 宽)

# 打印结果
print("矩形的面积是：", area)
print("矩形的周长是：", perimeter)