python–基础–3.1–基础语法–注释

1、注释

1. 不能被执行
2. 对程序代码进行解释说明，增强程序的可读性

2、注释方式

2.1、单行注释

# 注释内容

2.2、多行注释

""" 注释内容"""

2.3、案例

# 单行注释
print(13.14)

"""
再次打印(13.14
用来解释多行注释
"""
print(13.14)

3、什么时候需要使用注释？

1. 注释不是越多越好，对于一目了然的代码，不需要添加注释
2. 对于 复杂的操作，应该在操作开始前写上若干行注释
3. 对于 不是一目了然的代码，应在其行尾添加注释(为了提高可读性，注释应该至少离开代码 2 个空格)
4. 绝不要描述代码，假设阅读代码的人比你更懂 Python，他只是不知道你的代码要做什么

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

4、关于代码规范

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

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