1、单行注释(行注释)
Python
中使用#
表示单行注释。单行注释可以作为单独的一行放在被注释代码行之上
,也可以放在语句或表达式之后
。
# 这是单行注释
- 当单行注释作为单独的一行放在被注释代码行
之上
时,为了保证代码的可读性,建议在#
后面添加一个空格
,再添加注释内容
。 - 当单行注释放在语句或表达式
之后
时,同样为了保证代码的可读性,建议注释
和语句
(或注释
和表达式
)之间至少
要有两个空格
。
2、多行注释(块注释)
当注释内容过多,导致一行无法显示
时,就可以使用多行注释。Python
中使用三个单引号
或三个双引号
表示多行注释。
'''
这是使用三个单引号的多行注释
'''
"""
这是使用三个双引号的多行注释
"""
3、注意
-
注释不是越多越好
。对于一目了然的代码,不需要添加注释。 - 对于
复杂的操作
,应该在操作开始前
写上相应的注释。 - 对于
不是一目了然的代码
,应该在代码之后
添加注释。 - 绝对
不要描述代码
。一般阅读代码的人都了解Python
的语法,只是不知道代码要干什么
。
4、关于代码规范
Python
官方提供有一系列PEP
文档,其中第8
篇文档专门针对Python
的代码格式
给出了建议,也就是俗称的PEP 8
。PEP 8文档地址。