1、单行注释(行注释)

Python中使用#表示单行注释。单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后

# 这是单行注释
  • 当单行注释作为单独的一行放在被注释代码行之上时,为了保证代码的可读性,建议在#后面添加一个空格,再添加注释内容
  • 当单行注释放在语句或表达式之后时,同样为了保证代码的可读性,建议注释语句(或注释表达式)之间至少要有两个空格

2、多行注释(块注释)

当注释内容过多,导致一行无法显示时,就可以使用多行注释。Python中使用三个单引号三个双引号表示多行注释。

'''
这是使用三个单引号的多行注释
'''

"""
这是使用三个双引号的多行注释
"""

3、注意

  • 注释不是越多越好。对于一目了然的代码,不需要添加注释。
  • 对于复杂的操作,应该在操作开始前写上相应的注释。
  • 对于不是一目了然的代码,应该在代码之后添加注释。
  • 绝对不要描述代码。一般阅读代码的人都了解Python的语法,只是不知道代码要干什么

4、关于代码规范

Python官方提供有一系列PEP文档,其中第8篇文档专门针对Python代码格式给出了建议,也就是俗称的PEP 8PEP 8文档地址