龙空技术网

Python编程第6课:15个编程好习惯之一,使用注释符

大陈看教育 135

前言:

目前兄弟们对“python逻辑操作符”大约比较注意,大家都想要知道一些“python逻辑操作符”的相关内容。那么小编在网摘上搜集了一些有关“python逻辑操作符””的相关内容,希望小伙伴们能喜欢,各位老铁们一起来了解一下吧!

【回顾:Python编程第5课作业答案】

第1题:D 第2题:sum= 17 第3题:第1行补充“sum=0”,第5行补充“sum=sum+i”

你答对了吗?

近日,大陈看到一个程序员总结的15个编程好习惯,其中第2条就是讲到注释符的使用,原文分享如下:

2. 优秀的代码文档跟编程语言知识一样重要。在代码源文件中,为每个主要的代码段添加注释,解释代码的基本逻辑。最好注明程序的构建和修改日期,以及修改的原因也是非常有必要的。

随着我们Python学习的深入,你会发现我们的程序越来越复杂,越来越长,可能在写的时候你还是很清楚的,可是说不定过了一段时间,你再回头看,就会懵了,我当时写了啥,为什么要这么写?

因此就像上面引用的经验分享那样,学会使用注释符在你的程序中写上说明,是很重要的,如果你哪天成为一个职业程序员,当你修改同事的代码的只用了2小时,但为了修改看懂这些代码确用了2天,你会不会抓狂呢?

图6.1

好了,废话不多说,我们先来看看Python的注释符有几种用法:

一、Python的注释符

1、单行注释

Python 使用“#”(输入法保持英文状态,按住Shift键不松手,再按数字3)作为单行注释的符号,语法格式为:

# 注释内容

从#开始,直到这行结束为止的所有内容都是注释。Python 解释器遇到#时,会忽略它后面的整行内容,不会执行。

说明多行代码的功能时一般将注释放在代码的上一行;

说明单行代码的功能时一般将注释放在代码的右侧;

例如:

#这是一个Python累加器sum=0#变量sum赋初始值为0#变量sum开始累加sum=sum+1sum=sum+2sum=sum+3sum=sum+4print("sum=",sum)#输出变量sum的值

2、多行注释

多行注释指的是一次性注释程序中多行的内容(包含一行)。

Python 使用三个连续的单引号'''或者三个连续的双引号"""注释多行内容,具体格式如下:

'''这是一个Python计数器的案例编写时间:2020年6月14日作者:大陈'''sum=0#变量sum赋初始值#变量sum开始计数sum=sum+1sum=sum+1sum=sum+1print("sum=",sum)#输出变量sum的值

或者

"""这是一个Python计数器的案例编写时间:2020年6月14日作者:大陈"""sum=0#变量sum赋初始值#变量sum开始计数sum=sum+1sum=sum+1sum=sum+1print("sum=",sum)#输出变量sum的值

多行注释通常用来为 Python 文件、模块、类或者函数等添加版权或者功能描述信息。

二、Python注释符的2大用途

1、起提示、说明、解释的作用

注释用来向用户提示或解释某些代码的作用和功能,它可以出现在代码中的任何位置。Python 解释器在执行代码时会忽略注释,不做任何处理,就好像它不存在一样。注释的最大作用是提高程序的可读性,没有注释的程序简直就是天书!

2、在程序调试时缩小错误所在范围

在调试(Debug)程序的过程中,注释还可以用来临时移除无用的代码。举个例子,如果你觉得某段代码可能有问题,可以先把这段代码注释起来,让 Python 解释器忽略这段代码,然后再运行。如果程序可以正常执行,则可以说明错误就是由这段代码引起的;反之,如果依然出现相同的错误,则可以说明错误不是由这段代码引起的。

在调试程序的过程中使用注释可以缩小错误所在的范围,提高调试程序的效率。

三、Python注释符使用的注意事项

大陈在CSDN上看到youxin2012写了一篇文章,非常系统,分15种情况写了书写注释时的注意事项,例如源文件头部、函数头部等怎么书写注释、书写哪些内容都有举实例,对于初学者养成良好的编程习惯有很好的借鉴意义,虽然他不是用的Python语言,但使用注意事项是相通的,这里分享给大家。

图6.2

标签: #python逻辑操作符