注释目标01. 注释的作用使用用自己熟悉的语言,在程序中对某些代码进行标注说明,增强程序的可读性
 02. 单行注释(行注释)# 这是第一个单行注释
print("hello python")
为了保证代码的可读性,# 后面建议先添加一个空格,然后再编写相应的说明文字
在代码后面增加的单行注释print("hello python") # 输出 `hello python`
03. 多行注释(块注释)"""
这是一个多行注释
在多行注释之间,可以写很多很多的内容……
"""
print("hello python")
什么时候需要使用注释?- 注释不是越多越好,对于一目了然的代码,不需要添加注释
- 对于 复杂的操作,应该在操作开始前写上若干行注释
- 对于 不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)
- 绝不要描述代码,假设阅读代码的人比你更懂 Python,他只是不知道你的代码要做什么
在一些正规的开发团队,通常会有 代码审核 的惯例,就是一个团队中彼此阅读对方的代码
关于代码规范任何语言的程序员,编写出符合规范的代码,是开始程序生涯的第一步
|