Python 注释，到底是不是“鸡肋”

Python 注释，到底是不是“鸡肋”

何为鸡肋

鸡肋，食之无味，弃之可惜。这是杨修对曹操军令"鸡肋"的解读，并由此招来杀身之祸。如今看来，曹丞相杀得好。

许多初学者对于注释会认为是"瞎耽误事。"，浪费不少时间和精力，对代码运行毫无影响，这不就是“鸡肋”吗？不怕大家笑话，我就是这样。

曾经沧海

多年前，秉着这个思路，在完成一个数千行的代码时我没有写一句注释。程序运行正常。直至去年由于功能变动需要修改程序时，彻底傻眼了，编程逻辑已经忘记的差不多了，拿着一堆代码看起来都认识，稍一改动就报错或运行结果出错，甚至于当时使用的变量是什么逻辑都已经忘记了，硬着头皮下手改改，一运行就完犊子了。

修改原始代码简直要耗费大量脑细胞啊，家人们。

如果从头再捋清楚当时的思路，简直难上加难，难于上青天啊！还不如从头开始重新写，这叫什么事儿！

假如，上天再给我一次机会的话，我会对当时的那个人说：“一定要把注释写好！”

注释写法

其实，在 Python 中，注释可以用来解释代码、提供文档说明或者临时禁用代码块，其实还挺好用。Python 中的注释有多种写法：

1.单行注释采用“#”

# 这里是单行注释

2.多行注释用"""或者’‘’

(1)第一种写法

‘’’

我是多行注释，可以换行，用三个单引号

这是多行注释，可以换行，用三个单引号

这是多行注释，可以换行，用三个单引号

‘’’

(2)第二种写法

“”"

还是可以换行的注释，用三个双引号 还是可以换行的注释，用三个双引号 还是可以换行的注释，用三个双引号

“”"

3.自定义函数中写好说明。

在编写自定义函数时，建议添加清晰明了的文档字符串，以便其他人阅读和理解代码。文档字符串应该包含函数的描述、输入参数的说明、返回值的说明以及其他必要的信息。这样可以提高代码的可维护性和可读性。

def greet(name):

“”"

这个函数用给定的名字向用户打招呼。参数：name (str)：用户的名字 返回值：str：一个消息

“”"

return f"Hello, {name}! Welcome to Python programming."

# 查看函数的文档字符串 print(greet._doc_)

# 通过 help()函数查看函数的说明 help(greet)

4.还有一个提醒大家，一定要使用英文状态下的符号“#、'、"”。

# 下面是一个示例代码块，其中包含了注释

x = 5 # 定义变量 x 并赋值为 5

y = 10 # 定义变量 y 并赋值为 10

# 输出变量 x 和 y 的和

print(x + y)

为了让几年后的你不那么恨如今的你，建议还是写好注释为好。

关于Python学习指南

学好 Python 不论是就业还是做副业赚钱都不错，但要学会 Python 还是要有一个学习规划。最后给大家分享一份全套的 Python 学习资料，给那些想学习 Python 的小伙伴们一点帮助！

包括：Python激活码+安装包、Python web开发，Python爬虫，Python数据分析，人工智能、自动化办公等学习教程。让你从零基础系统性的学好Python！

👉Python所有方向的学习路线👈

Python所有方向路线就是把Python常用的技术点做整理，形成各个领域的知识点汇总，它的用处就在于，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。（全套教程文末领取）

👉Python学习视频600合集👈

观看零基础学习视频，看视频学习是最快捷也是最有效果的方式，跟着视频中老师的思路，从基础到深入，还是很容易入门的。

温馨提示：篇幅有限，已打包文件夹，获取方式在：文末

👉Python70个实战练手案例&源码👈

光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

👉Python大厂面试资料👈

我们学习Python必然是为了找到高薪的工作，下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料，并且有阿里大佬给出了权威的解答，刷完这一套面试资料相信大家都能找到满意的工作。

👉Python副业兼职路线&方法👈

学好 Python 不论是就业还是做副业赚钱都不错，但要学会兼职接单还是要有一个学习规划。

👉 这份完整版的Python全套学习资料已经上传，朋友们如果需要可以扫描下方CSDN官方认证二维码或者点击链接免费领取【保证100%免费】

点击免费领取《CSDN大礼包》：Python入门到进阶资料 & 实战源码 & 兼职接单方法 安全链接免费领取