1 Python 注释概述
注释(Comments)是用来向开发者(用户)提示或解释某些代码的思路、作用和功能等,可以添加到代码中的任何位置。Python 解释器(Python Interpreter)在执行程序(代码)时会忽略注释部分,不做任何处理,即注释部分不会被 Python 解释器执行。
在代码中添加适当的注释量很重要,注释通常占源代码的 1/3 左右。
Python 支持两种类型的注释:单行注释和多行注释。
2 Python 注释的作用
2.1 调试代码
在调试(Debug)程序的过程中,单行注释可以用来临时快速注释某些代码,达到缩小错误范围、提高调试程序效率的目的。
具体操作如下:
在不确定具体是哪一行代码出错的情况下,我们可以先把觉得可能有问题的代码注释起来,然后再运行程序观察结果。如果程序可以正常执行,则可以说明错误就是由这段代码引起的;反之,如果依然出现相同的错误,则可以说明错误不是由这段代码引起的。
2.2 提高程序的可读性
注释的最大作用是提高程序的可读性,没有注释的程序是很难让人看懂的,说是天书也不为过。
更甚至,自己写的代码,过了一段时间以后,自己也会忘记思路或者目的。
3 Python 单行注释
3.1 Python 单行注释概述
Python 中是使用井号#作为单行注释的符号,其语法格式如下所示:
# 添加的注释内容
对以上语法格式的说明:
#作为单行注释的符号。
从井号#开始,直到这行结束为止的所有内容都是注释。Python 解释器遇到#时,会忽略它后面的整行内容,即#之后的一行内容都属于注释部分。
3.2 单行注释注释单行代码的情况
单行注释注释单行代码时通常会将注释放在代码的右侧,与代码之间用两个空格隔开,如下所示:
print("码农阿杰") # 输出笔者的微信公众号名称
print("https://www.cnblogs.com/manongajie/") # 输出笔者的博客园博客地址
print("https://blog.csdn.net/manong