一、为什么要写注释
如果代码没有注释，那代码的可读性会变得非常差，可能过一段时间你自己也看不明白实现了什么功能。因此要养成写注释的习惯，注释并不会影响代码的运行，解释器在执行代码时会直接忽略注释。总之，注释存在以下诸多优点
- 提高可读性：帮助开发者(自己)理解代码的意图、功能和设计。
- 文档化：作为代码的简短文档，直接在代码中提供必要的上下文信息。
- 团队协作：帮助团队成员快速理解代码，减少沟通成本，避免开发重复功能。
- 调试与测试：帮助标注待处理的 bug 或问题，帮助开发者跟踪代码修改的历史。
- 增强可扩展性：标记出“TODO”项或未来的改进建议，清楚地看到哪些部分可以进一步扩展或改进。
二、如何写注释
注释分为多行注释和单行注释，需要根据实际情况选择多行或者单注释。这里我们分别演示一下多行注释和单行注释的用法。
2.1、单行注释
顾名思义，单行注释即给在单个一行加注释， 注释可以单独占一行，也可以写在代码行的后面。
单行注释： （单独一行）
# 这是一行注释，实现了打印 hello world 的功能
print("hello world")
单行注释： （写在行尾）
print("hello world") # 这是注释，实现了打印 hello world 的功能
3.2、多行注释
多行注释即连续多行都是注释的一部分，解释器执行中降多行一起忽略，多行注释也有两种写法三个单引号或者三个双引号。示例如下：
单行注释： （三个单引号）
'''
这是多行注释，实现了xxx的功能
代码编写与2024-12-23
'''
print("hello world")
单行注释： （三个双引号）
"""
这是多行注释，实现了xxx的功能
代码编写与2024-12-23
"""
print("hello world")
3.3、注释实例
以下为一个函数的注释实例
def addplus(a, b):
"""
计算两个数的和
:param a: 整数a, 被加数
:param b: 整数b, 被加数
:return: 返回链各个数的和
"""
mysum = a + b
return mysum
示例中，使用了多行注释的方法，详细解释了 addplus 这个函数实现的功能，入参和返回值。这也是python推荐的注释规范，如果你使用的是pycharm，在函数编写完之后输入三个单引号，pychram会自动生成这个注释格式。
四、结尾
1、注释虽好，不要滥用。过多的注释反而会降低代码的可读性。
2、如果你是按照笔者的文章逐篇学习python的。看不懂3.3章节的代码也没关系，有个印象即可，后续我们在函数章节学习。
「真诚赞赏，手留余香」
WangFuJie Blog
真诚赞赏，手留余香
使用微信扫描二维码完成支付
