注释的重要性
如果我们是做独立项目,或者是唯一 一位来查看自己编写的代码开发人员,那么我们可以按照自己的想法来写代码。但是如果是和别人合作的话,代码没有一点注释的话,很难让别人去理解和明白代码的含义,这会增加开发人员合作的负担,但是有了注释会大大的减轻负担。
学会注释的好处:
(1)有助于保持一致性
(2)有助于理解
(3)帮助修补程序或快速修复
(4)有助于加快开发过程
(5)有助于提高协作效率
注意:
在代码的注释过程中注意不要写太长,增加代码的冗余度,不用花大量时间去写一些不重要的注释。
Python中的注释有单行注释和多行注释:
Python中单行注释以 # 开头,例如:
# 这是一个注释 print("Hello, World!")
多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来,例如:
1、单引号(''')
#!/usr/bin/python3 ''' 这是多行注释,用三个单引号 这是多行注释,用三个单引号 这是多行注释,用三个单引号 ''' print("Hello, World!")
2、双引号(""")
#!/usr/bin/python3 """ 这是多行注释,用三个双引号 这是多行注释,用三个双引号 这是多行注释,用三个双引号 """ print("Hello, World!")