目录
不知道大家平时买不买东西,我估计应该没人不买吧,既然如此,那我想你们都应该见过产品说明书吧,再或者某些软件,我们在初次登录的时候,会有新手指引,那你说这些东西没有可以吗,其实也行是吧,但是为什么还是要有呢,不就是为了进行介绍说明嘛,以便让你可以尽快的熟悉和掌握其使用方法,避免错误,同样的,在我们的Python中,也有这样的说明,我们称其为注释。
注释的概念及分类
注释是指在代码中对代码功能进行解释说明的标注性文字,就算你不懂代码,但是通过注释也可以大概知道程序中有些什么,因此,注释可以提高代码的可读性。由于注释是给人类看的,注释的内容将被Python解释器忽略,并不会在执行结果中体现出来。
在Python中,通常包括3种类型的注释,分别是单行注释、多行注释和编码声明注释。
单行注释
在Python中,使用“#”作为单行注释的符号。从符号“#”开始直到换行为止,其后面所有的内容都作为注释的内容。
语法格式如下:
# 注释内容
单行注释可以放在要注释代码的前一行,也可以放在要注释代码的右侧。
例如:
# 要求输入姓名
name = input("请输入你的姓名:")
age = input("请输入你的年龄:") # 要求输入年龄
以上两种形式的注释都是正确的。
多行注释
在Python中,使用三个单引号('''……''')或者三个双引号("""……""")作为多行注释的符号,一对三引号之前的代码都将被代码解释器忽略。
语法格式如下:
'''
注释内容1
注释内容2
'''
"""
注释内容1
注释内容2
"""
多行注释除了可以用来为Python文件、模块、类或者函数等添加版权、功能等信息,还可以用来解释代码中重要的函数、参数等信息,以便日后进行代码维护。
例如:
'''
登录模块
开发者:Allen
版本号:1.0
时间:2019年10月
'''
如果你不喜欢多行注释,你也可以用单行注释,将每一行都单独注释,只要你能对你的代码介绍清楚了,用单行注释或者多行注释都行。
编码声明注释
在Python中编写代码的时候,有时候我们可能为了保持编码格式或者避免乱码的出现,需要手动指定某种字符编码类型,此时,就需要在文件开头加上声明注释。
语法格式如下:
# -*- coding:编码 -*-
字符编码格式有很多,根据实际需要自行百度,例如保存文件编码格式为UTF-8,可以这样:
# -*- coding:utf-8 -*-
如果想做一个优秀的程序员,那么,为代码加注释是必须要做的,因此,这个良好的习惯就从现在开始培养吧!
总结
在企业的实际开发工作中,程序都是很复杂且庞大的,所以开发工作都是由多人合作完成的,以模块化的方式同步进行,为了能更好的进行模块对接,降低沟通成本,注释就显得很重要了,每个模块的作用是什么,模块中都有哪些功能一目了然,但要确保注释的内容都是重要的事情,无用的代码是不需要加注释的,另外,因为代码的注释会被解释器忽略,所以我们也可以利用注释来进行代码调试,将可能有错误的代码注释起来,便于查找程序错误。