Python基础第三讲：这样写 Python 代码注释，方便你我他

注释就是在你的代码里面添加上解释说明。

代码是告诉阅读的人做什么事情，而注释是告诉阅读的人为什么这么做。

这点在学习编程的时候，特别重要；尤其在刚开始的时候一定要养成写注释的习惯，不要嫌其麻烦，因为注释真的很方便阅读代码的人理解。

在实际工作中，项目一般都很大，需要协作完成。

如果有人没写注释就给下一个人阅读，那阅读有可能变成特别痛苦的一件事情。有时候代码漂不漂亮也要看注释是不是全面。

不过目前的普遍状况是，国内很多人，即使是工作很多年的老程序员也不喜欢写注释。笔者在看国内的 Python 或其它编程语言视频教程时也发现很多老师不写注释。因为麻烦，认为是多干活。

这个观点是错误的，

因为即使自己写的代码，2年以后我相信你自己都不记得写的是什么了。

另外，据我了解，一些大公司代码注释写的都非常全面，比如Google、 Oracle等。

既然注释这么重要，咱们看看Python的注释都有哪些呢？

01 单行注释

在Python中，单行注释用井号（#）标识，也就是 # 后面的内容；

但是，要注意以下几点:

A: # 和注释内容之间必须留一个空格才可以否则不符合规范， 如图所示：

B: 注释的作用是解释说明，并不是真的需要运行。如下代码。你只会看到你好，小码哥，其他的你看不到。

C: 注释可以写在代码的任何地方，甚至可以在代码行中使用。推荐写在代码上面

D: 您写的注释一定要注意语言的简短、贴切、切中要害。PEP 8建议将代码保持在79个字符或更少，代码行中的注释最多为72个字符。如果您的注释接近或超过了该长度，则需要将其转变为多行注释。

02 多行注释

多行注释用一对三引号（''' ''' ）或者一对三个双引号(""" """)表示。

而多行注释一般用在整个文本或者某一个代码区域的解释说明，其中三个双引号表示整个文档的说明。

有一点需要注意：双引号是英文输入法的，不是中文输入法。今天有一个圈友遇到该问题，他怎么无法注释。希望大家注意。大家一起学习的效率还是比较高的，因为他人的问题就是自己的经验，及早避免。

如果我们有很长一段文字需要注释呢？或者批量将代码转化为注释，一行一行地注释它可能需要很多时间！

在这种情况下，只需选择需要作为注释的代码行并在PC上按Ctrl+/，或在Mac上按Cmd+/。所有选中的代码前都将加上一个#标记，并被程序忽略。

如果您的注释行数较多，或者您正在阅读的脚本中的注释非常长，那么您的文本编辑器可能会让您选择使用左侧 减号(-)的折叠它们。如下图

折叠前后对比

最后，需要注意一点：注释虽然比较方便，但是并不是每一行代码都需要注释。只有关键的地方需要，比如：新的语法点、代码重点解决的问题、重要的细节或者结论等。

以上内容摘自《零基础轻松学 Python》