当前位置:   article > 正文

Python的语法特点之注释规则_python 三引号和多行注释的区别

python 三引号和多行注释的区别


前言

很多零基础大白经常问我,学习Python第一步是什么呢?接下来我告诉大家,第一步是了解它的语法特点,就像我们打游戏一样,首先必需要学习游戏的规则,不然就容易出局,Python的语法特点主要包含:注释规则、代码缩进、编码规范等等,今天我们学习注释规则。


一、注释的定义

什么叫注释呢?在程序中,注释就是对代码的解释和说明,就好像我们去商场买衣服,衣服上面的价格,品牌,材质这些标签就是对衣服的说明。如同这些衣服标签一样,注释的功能就是让他人更好了解自己代码实现的功能,从而帮助程序猿更好的阅读代码。

需要注意:注释的内容是不会被Python解释器执行的。

二、注释的分类

Python中包括3种类型的注释:分别是单行注释、多行注释、中文编码声明注释。这些注释在pycharm中注释效果如下图所示:

在这里插入图片描述

(1) 单行注释:

在Python中,使用‘#’作为单行注释的符号,‘#’后面所有的内容都是注释内容。
语法如下:

# 注释内容
  • 1

单行注释可以放在要注释代码的上一行,也可以放在要注释代码的右侧。如下两种形式都是正确的。

第一种形式(非常推荐):

# 打印输出‘我爱Python’这句话
print('我爱Python')
  • 1
  • 2

第二种形式:

print('我爱Python')  # 打印输出‘我爱Python’这句话
  • 1

上面两种形式的运行结果都是相同的,如下图所示:

在这里插入图片描述

(2) 多行注释:

Python中并没有单独用来做多行注释的标记符号,和单行注释使用‘#’不同,多行注释是用一对三引号(‘’‘…’‘’)或者(“”“…”“”)来包裹注释部分内容。

语法格式如下:

'''
注释语句1
注释语句2
注释语句3
'''
  • 1
  • 2
  • 3
  • 4
  • 5

或者

"""
注释语句1
注释语句2
注释语句3
"""
  • 1
  • 2
  • 3
  • 4
  • 5

多行注释通常放在代码头部用来为Python文件添加版权、功能等信息,如下示例所示:

'''
文件名:Python注释规则.py
创建人:程序员小十一
创建日期:2022年12月12日
'''
  • 1
  • 2
  • 3
  • 4
  • 5

特别注意:三引号是在英文状态下输入,中文状态下输入会报错。

(3) 中文编码声明注释:

为什么会有这个注释?我给大家解释一下,因为我们日后写代码中多数会出现中文汉字,如果不做中文编码声明的话,容易导致代码报错,所以我们可以看到一般代码的头部都会有这行注释:

# -*- coding:utf-8 -*-
  • 1

中文编码声明注释的语法格式如下:

# -*- coding:编码 -*-
  • 1

或者写为

# coding=编码
  • 1

上述语法中,编码就是文件所使用的字符编码类型,常见编码类型有ASCII、GBK、GB2312、UTF-8等等,如果采用GBK编码,则设置为gbk,可以使用如下的中文编码声明注释:

# -*- coding:gbk -*-
  • 1

总结

优秀的代码一定会有恰到好处的注释,添加注释时,要有意义,也就是能充分解释代码的功能和用途。

声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:【wpsshop博客】
推荐阅读
相关标签
  

闽ICP备14008679号