注释

文章内容

• 注释的作用
• 单行注释（行注释）
• 多行注释（块注释）

01.注释的作用

使用自己熟悉的语言，在程序中对某些代码进行标注说明，增强程序的可读性

02.单行注释（行注释）

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

• 示例：

# 这是第一个单行注释
print("hello  hello")

为了保证代码的可读性，#后面建议先添加一个空格，然后再编写相应的说明文字

• 如果想要一件将所有的注释#后面都添加一个空格，可以采用下面的方式

点击重新格式化该文件就可以实现注释#后面都添加一个空格

在代码后面增加的单行注释

• 在程序开发时，同样可以使用#在代码的后面(旁边)增加说明性的文字
• 但是，需要注意的是，为了保证代码的可读性，注释和代码之间至少要有两个空格
• 示例代码如下:

print("hello  world")  # 输出欢迎信息

03.多行注释（块注释）

• 如果希望编写的注释信息很多，一行无法显示，就可以使用多行注释
• 要在Python程序中使用多行注释，可以用一对连续的三个引号(单引号和双引号都可以)
• 示例代码如下:

"""
这是一个多行注释
。。。
。。。
"""
print("hello  world") 

什么时候需要使用注释

1. 注释不是越多越好，对于一目了然的代码，不需要添加注释

2. 对于复杂的操作，应该在操作开始前写上若干行注释

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

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

在一些正规的开发团队，通常会有代码审核的惯例，就是一个团队中彼此阅读对方的代码

关于代码规范

• 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/

任何语言的程序员，编写出符合规范的代码，是开始程序生涯的第一步