单行注释:
- 以
#
开头,#
右边的所有东西都被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用 - 示例:
- 在一行添加注释 【
#
与注释之间最好有个空格,增加可读性】
# 这是第一个单行注释 print("hello python")
- 在代码末尾添加注释 【
#
代码之间有两个空格,与注释之间有一个空格】
print("hello python") # 输出 `hello python`
- 在一行添加注释 【
多行注释 (块注释)
- 使用情景;需要注释的部分较多
- 方式:使用一对 连续的三引号 (单引号和双引号都可以)
- 示例:
- 使用三引号注释
""" #### 这是一个多行注释 ... 在多行注释之间,可以写很多很多的内容…… """ print("hello 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/