【Python基础】Python注释详解:单行、多行、使用规范与易错点总结

【Python基础】Python注释详解:单行、多行、使用规范与易错点总结

在 Python 编程中,**注释(Comment)**虽然不会影响代码的执行结果,但在实际开发中却是不可或缺的一部分。良好的注释习惯不仅可以提高代码可读性,也便于团队协作、后期维护。

本文将全面介绍 Python 中的注释方式,包括:单行注释、多行注释、使用规范以及常见错误,适合初学者与开发者查阅学习。

1. Python注释基础

在 Python 中,注释不会被解释器执行,仅供开发者阅读理解。Python 支持两种主要类型的注释:

单行注释(Single-line Comment)

多行注释(Multi-line Comment)

1.1 单行注释

在 Python 中,单行注释以 # 开头,后跟注释内容:

# 这是一个单行注释

print("Hello, World!") # 输出 Hello, World!

快捷键提示:

在大多数 IDE(如 VSCode、PyCharm)中,可以使用快捷键来快速添加/取消注释:

Windows/Linux:Ctrl + /

MacOS:Command + /

1.2 多行注释

Python 没有专门的多行注释语法,但我们通常使用三引号(''' 或 """)来模拟多行注释。虽然这些语法本质上是字符串,但如果不赋值、不参与运算,它们不会影响程序运行。

1.2.1 使用三个单引号(''')注释

'''

这是一个多行注释示例,

使用三个单引号包裹内容。

'''

print("Hello, World!")

1.2.2 使用三个双引号(""")注释

"""

这也是一个多行注释示例,

使用三个双引号包裹内容。

"""

print("Hello, World!")

注意:多行注释可以嵌套,单行注释不能嵌套。

2. 注释的使用规范(开发者建议)

在企业项目或团队开发中,良好的注释规范是必须遵守的。以下是一些通用建议:

✅ 推荐做法

注释内容简洁明了,直击代码功能;

及时更新注释内容,保持与代码一致;

函数或类前添加文档字符串(docstring)说明功能;

对复杂逻辑进行逐步解释;

避免无意义的注释(如:# 打印输出 这样的废话注释)。

示例:

def calculate_area(radius):

"""

根据半径计算圆的面积

:param radius: float 半径

:return: float 面积

"""

return 3.14159 * radius * radius

3. 常见易错点

在实际使用中,也有一些关于注释的误区和错误需要注意:

易错点正确做法❌ 注释和代码写在一行,缺少空格✅ 注释前加一个空格,如:print(x) # 输出结果❌ 使用中文注释时未设置编码✅ 在 Python 2 中建议加上 # -*- coding: utf-8 -*-(Python 3 默认支持 UTF-8)❌ 滥用多行注释当文档字符串✅ 多行注释主要用于临时注释,文档字符串应放在函数/类/模块开头

4. 总结

类型语法用途说明单行注释# 注释内容快速说明某一行代码多行注释'''注释''' 或 """注释"""注释一段文字或用于文档字符串文档注释(推荐)"""函数说明"""建议用于函数/类的说明文档

📌 参考建议

虽然多行注释使用三引号很方便,但在一些 IDE 中可能会被当作字符串处理,因此推荐使用多个单行注释 # 来进行多行注释的替代,更符合 Python 社区风格。

📢 如果你觉得本篇文章对你有帮助,欢迎点赞👍、评论💬、收藏📂,你的支持是我持续更新的动力!

📎 后续我将持续更新更多 Python 基础与进阶知识,欢迎关注!

🎯 相关推荐

办公软件有哪些套装软件
365bet真人网投

办公软件有哪些套装软件

📅 10-17 👀 7541
乐天名字寓意及打分
bet体育365官网怎么样

乐天名字寓意及打分

📅 09-09 👀 6066
全球最大的游戏发行平台Steam深度剖析
bt365app官方下载登录

全球最大的游戏发行平台Steam深度剖析

📅 07-03 👀 5430