Python基础杂货店（三）

• 注释

1. 注释的作用

注释就是对某些代码进行标注说明，以增强代码的可读性。我们在写程序的时候，编写的某一部分代码的意图不太明显，这时候就需要对这一部分代码加以说明，来明确这一部分到的意图。一般的编程语句有单行注释和多行注释

2. 单行注释

• 单行注释是以#开头，#右边的所有的文字都被当做说明文字，而不是真正要执行的程序，只起到辅助说明作用

• 示例代码如下（为了保障可读性，#后面一般要加上一个空格）：

• # 这是单行注释
  print("Hello word")

• 在代码的后面加上单行注释
  • 为了保障程序的可读性，代码和注释之间至少要有两个空格
  • 示例代码如下：

    print("Hello word")  # 这是代码后面的单行注释

• 在代码后面加上单行注释比在代码上面加上单行注释更加省空间，更加简洁

3. 多行注释

• 如何注释太多，一行无法放下，那么就需要用到多行注释了

• 多行注释可以用一对连续的三个引号（单引号和双引号都行）

• 示例代码：

  """
  这是多行注释，
  里面有超多的内容
  """
  print("Hello word")

4. 什么时候需要使用注释

• 注释不是越多越好，对于很容易理解的代码不需要注释

• 对于不能一下子明白的复杂操作，需要在代码之前加上多行注释

• 对于 不是一目了然的代码，应在其行尾添加注释（为了提高可读性，注释应该至少离开代码 2 个空格）

• 绝不要描述代码，假设阅读代码的人比你更懂 Python，他只是不知道你的代码要做什么

5. 代码相关规范

• Python 官方提供有一系列 PEP（Python Enhancement Proposals） 文档

• 其中第 8 篇文档专门针对 Python 的代码格式 给出了建议，也就是俗称的 PEP 8

• 文档地址：https://www.python.org/dev/peps/pep-0008/

• 谷歌有对应的中文文档：http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

•