Python 的注释

说明

《Python 教程》持续更新中，提供建议、纠错、催更等加作者微信: gairuo123（备注：pandas教程）和关注公众号「盖若」ID: gairuo。跟作者学习，请进入 Python学习课程。欢迎关注作者出版的书籍：《深入浅出Pandas》和《Python之光》。

在用Python编写代码时，重要的是要确保您的代码能够被其他人轻松理解。为变量提供明显的名称、定义显式函数和组织代码都是实现这一点的好方法。另一个提高代码可读性的简单方法是使用注释！

语法

注释以井号（#）开头，在物理行末尾截止。注意，井号不是字符串字面值。除非应用隐式行拼接规则，否则，注释代表逻辑行结束。句法不解析注释。

# 这是一个注释
a = 1

Python 忽略 # 标记之后直到行末尾的所有内容。您可以将它们插入代码中的任何位置，甚至与其他代码在同一行内：

print(123)  # 这是一个注释

当运行上面的代码时，您将只看到输出将运行，其他一切都被忽略。

评论应该简短、易读、切中要害。虽然PEP8建议代码每行79个字符或更少，但它建议内联注释和文档字符串最多72个字符。如果你的评论接近或超过了这个长度，那么你会想把它分散在多行上。如

# 这是一个注释 1，由于太多
# 接着上边，这是一个注释
a = 1

多行注释

不幸的是，Python无法像在 C、Java 和 Go 等语言中那样编写多行注释。虽然Python没有本机的多行注释功能，但您可以在 Python 中创建多行注释，有两种简单的方法。
第一种方法是在每行后面按回车键，添加一个新的 # 标记，然后继续注释：

"""
This is a comment
written in
more than just one line
"""
print("Hello, World!")

def fun():
    # This is a pretty good example
    # of how you can spread comments
    # over multiple lines in Python
    pass

但是通常通过一个三引号的字符串字面量来完成，如：

def fun():
    """
    If I really hate pressing `enter` and
    typing all those hash marks, I could
    just do this instead
    """
    pass

函数中开头的三引号注释，被称为 docstring。

编码声明

Python 脚本第一或第二行的注释匹配正则表达式 coding[=:]\s*([-\w.]+) 时，该注释会被当作编码声明；这个表达式的第一组指定了源码文件的编码。编码声明必须独占一行，在第二行时，则第一行必须也是注释。编码表达式的形式如下：

# -*- coding: <encoding-name> -*-

这也是 GNU Emacs 认可的形式，此外，还支持如下形式：

# vim:fileencoding=<encoding-name>

这是 Bram Moolenaar 的 VIM 认可的形式。

没有编码声明时，默认编码为 UTF-8。此外，如果文件的首字节为 UTF-8 字节顺序标志（b'\xef\xbb\xbf'），文件编码也声明为 UTF-8（这是 Microsoft 的 notepad 等软件支持的形式）。

如果声明了编码格式，该编码格式的名称必须是 Python 可识别的 (参见标准编码)。编码格式会被用于所有的词法分析，包括字符串字面值、注释和标识符等。

注释的作用

作用有：

提高程序的可读性，让看代码的他人或者未来的自己认识你的代码逻辑。
可以自成文挡，利用工具可以自动解析输出程序的代码文档，如 docstring 可以用内置模块 pydoc 来生成文档。
用来调试程序。如果你觉得某段代码可能有问题，可以先把这段代码注释起来，让 Python 解释器忽略这段代码，然后再运行。如果程序可以正常执行，则可以说明错误就是由这段代码引起的；反之，如果依然出现相同的错误，则可以说明错误不是由这段代码引起的。

总结

注释的作用：用人类熟悉的语⾔对代码进行解释说明，方便后期维护。
解释器不执行注释内容
注释的分类：
- 单行： # 注释内容，一般快捷键 ctrl+/
- 多行：连续多行 # 注释，或者三引号的字符串

参考

https://docs.python.org/zh-cn/3/reference/lexical_analysis.html#comments
https://realpython.com/python-comments-guide/

Python 的注释

语法

多行注释

编码声明

注释的作用

总结

参考

相关内容