1.注释的作用
使用自己熟悉的语言,对程序中某些代码进行标注说明,增强系统的可读性。
2.单行注释(行注释)
- 以
#
开头,#
右边的所有东西都被当作说明文字,而不是真正要执行的程序,只起到辅助说明作用:
– 示例代码如下:
# 这是一个单行注释
print("hello, world")
- 可在
#
后面添加一个空格,符合代码格式规范。 - 在pycharm中,若要批量改格式规范,可右键代码处的
小灯泡
图标,选择Reformat File
。
2.1在代码后面增加的单行注释
- 在程序开发时,同样可以使用
#
在代码的后面(旁边)增加说明性的文字。 - 但是需要注意,为了保证代码的可读性,注释和代码之间至少要有两个空格。
– 示例代码如下:
print("hello, world") # 输出 hello world
3.多行注释(块注释)
- 如歌希望编写的注释信息很多。一行无法显示,即可以使用多行注释。
- 要在python在、程序中使用多行注释,可以用一对连续的三个引号
(单引号和双引号都可以)
– 示例代码如下:
"""
这是一个多行注释
在多行注释之间,可以写很多内容...
"""
print("hello, world")
4. 什么时候需要注释
1.注释不是越多越好,对于一目了然的代码,不需要添加注释。
2.对于复杂的操作,应该在操作开始前写上若干行注释
3.对于不是一目了然的代码,应该在其行尾添加注释
4.绝不要描述代码内容
参考资料:b站 黑马程序员视频