什么是注释?
注释就是穿插在代码中的一些对代码的注解、说明,主要用于增加代码的可读性。
Python程序在运行过程中,会自动忽略代码中的注释,也就是说,注释是给人看的,而不是给计算机使用的。
注释分类
注释可以分为单行注释和多行注释。
单行注释
单行注释的语法如下:
# 这里添加注释内容
单行注释就是在要注释的内容前面添加一个#
号和空格符。
多行注释
多行注释的语法如下:
'''
注释的第一行内容;
注释的第二行内容;
注释的第三行内容。
'''
"""
注释的第一行内容;
注释的第二行内容;
注释的第三行内容。
"""
多行注释就是将要注释的内容前面添加三个单引号'''
(也可以是双引号"""
),然后再注释的内容后面再添加三个单引号'''
(或者是双引号"""
)。
注释的原则
-
不用给全部代码加注释,只需要在自己觉得重要或不好理解的部分加注释即可。例如下面这段代码:
# 将变量a的值加1 a = a + 1
上面的代码,别人一看就知道是把变量的值加1,还写个毛线的注释…
-
注释可以是中文或者英文,但是不要用拼音…
-
注释不仅是给自己看的,也是给别人看的,所以要站在读者的角度考虑。
注释的作用
- 增加代码可读性:良好的注释能让人更容易理解代码的逻辑和功能,便于自己或他人维护。
- 调试代码:调试过程中,如果感觉某段代码有问题,可以先将其注释掉,对比一下问题是否发生变化。