『无为则无心』Python基础 — 6、Python的注释

时间:2022-06-01 16:41:16

提示:完成了前面的准备工作,之后的文章开始介绍Python的基本语法了。

Python代码的基本规范如下:

  • 1、Python 文件将以 .py 为扩展名。
  • 2、在Python中严格区分大小写(大小写敏感),如果写错了大小写,程序会报错。
  • 3、Python中的每一行就是一条语句,每条语句以换行结束,不用;分号结束。
  • 4、Python是缩进严格的语言,所以在Python中不要随便写缩进。
    • 缩进的好处是强迫你写出缩进较少的代码,你会倾向于把一段很长的代码拆分成若干函数,从而得到缩进较少的代码。
    • 缩进的坏处就是复制-粘贴功能失效了,当你重构代码时,粘贴过去的代码必须重新检查缩进是否正确。
  • 5、一条语句可以分多行编写,多行编写时语句后边以\结尾 。
  • 6、Python中每一行语句不要过长(规范中建议每行不要超过80个字符)。

扩展:

1、注释的作用

通过使用自己熟悉的语言,在程序中提示或解释某些关键代码的思路、作用和功能等,能够大大增强程序的可读性。(代码的可读性是非常重要的)

代码注释效果如下图:

  • 没有添加注释的代码。

    『无为则无心』Python基础 — 6、Python的注释
  • 添加注释的代码。

    『无为则无心』Python基础 — 6、Python的注释

2、注释的分类

注释分为两类:单行注释多行注释

单行注释

#作为单行注释的符号。只注释一行内容,语法如下:

# 注释内容

多行注释

可以注释多行内容,常用来为 Python 函数、类、模块等等添加功能、版本和作者等描述信息, 语法如下:

#写法一:一对三双引号
"""
第一行注释
第二行注释
第三行注释
""" #写法二:一对三单引号
'''
注释1
注释2
注释3
'''

3、注释的注意事项

  • Python 解释器(Python Interpreter)在执行程序(代码)时会忽略注释部分,不做任何处理。

    当Python解释器解析Python文件的时候,一旦发现出现了#,就会认为#右边的文字全部都是说明性的文字,Python的解释器会直接跳过这一行,解释下一行代码。
  • 极简单的注释可以放到一行代码的后面,一般习惯代码后面添加两个空格,再书写注释文字。
    print('hello Python')  # 输出
  • #号和注释之间需要加上一个空格,不是强制,是规范。
  • Python 多行注释不支持嵌套,如下所示为错误写法:
    '''
    外层注释
    '''
    内层注释
    '''
    '''
  • 多行注释符号'''"""也可以作为字符串的开始和结束标记。

    Python 中当多行注释符号作为字符串的一部分出现时,就不能再将它们当做多行注释标记,而应该看做是字符串的一部分,如下所示:
    #方式一
    print("hello world ! hello python !")
    print('hello world !')
    print("""真香""")
    print('''是真的''') #方式二
    str1 = "hello world ! hello python !"
    str2 = 'hello world !'
    str3 = """真香"""
    str4 = '''是真的'''
    print(str1)
    print(str2)
    print(str3)
    print(str4) """
    #执行结果都是
    hello world ! hello python !
    hello world !
    真香
    是真的
    """

4、什么时候需要使用注释

  • 注释不是越多越好,对于一目了然的代码,不需要添加注释。
  • 对于 复杂的操作,应该在操作开始前写上若干行注释。
  • 绝不要描述代码,假设阅读代码的人比你更懂 Python,他只是不知道你的代码要做什么,代码注释要做功能性描述。

在一些正规的开发团队,通常会有 代码审核 的惯例,就是一个团队中彼此阅读对方的代码。

5、总结

  • 注释是一个程序员必须要具有的良好编程习惯。
  • 注释的作用有两个:
    • 说明代码。
    • 调试程序。
  • 注释快捷键
    • 单行注释:ctrl + /
    • 多行注释:没有,只能选中多行,在ctrl + /