1 # 这是第一个注释 2 print("hello hello") 3 4 # 这是第二个注释 5 print("hello world") # 代码后面也可以添加注释 6 7 # 多行注释,以三个单引号或者单个双引号开始并结束(块注释) 8 """ 9 这是一个多行注释 10 。。。。 11 多行注释之间可以些很多很多内容 12 。。。。 13 注释结束 14 """
什么是时候需要使用注释?
1.注释并不是越多越好,对于一目了然得代码,不需要添加注释
2.对于复杂得操作,应该在操作开始前写上若干行注释
3.对于不是一目了然得代码,应该在其行尾添加注释(为了提高可读性,注释应该至少离开代码2个空格)
4.绝不要描述代码,假设阅读代码得人比你更懂python,他只是不知道你的代码要做什么
在一些正规得开发团队,通常会有代码审核得惯例,就是一个团队中彼此阅读对方得代码
关于代码规范:
Python 官网提工有一系列PEP(Python Enhancement Proposals)文档
其中第8篇文档专门针对python得代码格式给出了建议,也就是俗称PEP8
文档地址:https://www.python.org/dev/peps/pep-0008/
谷歌对应得中文文档:https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/