课程首页 › 第9章 › 第51课

第51课 如何创建注释

第9章 注释帮助我们理解· 知识点:注释 · 原书 9.1

在程序代码中,特别是团队合作开发的程序代码,因为每个人的编程习惯都不一样,所以为了让别人能更好地看懂和理解代码,我们经常会用到注释。

注释简单理解为注明并解释,就是对于代码的创建者、创建时间、代码功能以及代码实现的说明。接下来我们来学习中的注释吧。

Python

插图

注释有那么多的好处,但是要如何创建注释呢?这就是今天的主要任务了。

Python中的注释分为单行注释和多行注释。

单行注释1.

单行注释以#开头,后面加上注释内容。

单行注释可以作为单独的一行放在被注释的代码上面,也可以放在代码后面。

无注释的代码是这样的:

插图

有注释的代码是这样的:

插图

依次单击菜单栏Run→Run Module选项来运行程序,程序运行结果如下:

Hello World!

上面第一段程序是没有注释的,第二段是有注释的,它们得到了相同的结果。正确的注释不会对我们的程序运行产生任何影响。

插图

这是在代码的后面加上了注释。如果想要在被注释代码的上面增加注释,要怎么做呢?我们来试试。

代码上面有注释是这样的:

插图

多行注释2.

很多时候一行注释写不明白,我们需要使用多行注释。

那么添加多行注释要怎么做呢?聪明的你是不是想到了可以使用上面的单行注释来完成?

插图
插图

依次单击菜单栏Run→Run Module选项来运行程序,程序运行结果如下:

Hello World!

在程序中,用多个#给代码加上了3行注释。

Python多行注释还有另一种写法,就是使用3个单引号或者双引号。

个单引号3

插图

依次单击菜单栏Run→Run Module选项来运行程序,程序运行结果如下:

Hello World!

个双引号3

插图

依次单击菜单栏Run→Run Module选项来运行程序,程序运行结果如下:

Hello World!

添加注释的要与不要

添加注释要明确说明代码实现的功能。

插图

在程序中,定义了一个tell()函数,在tell()函数的上面写了一行注释#说,这个注释不清楚,只有一个说字,没有表达函数的具体作用。

注释要详细表达函数的作用,这个注释我们来改改。

插图

在程序中,定义了tell()函数,在tell()函数的上面写了一行注释:

班长给值日生安排任务的函数,很具体地表达了函数的作用。

#

添加注释的时候需要注意几个不要:

(1)不要每行代码都写注释。

比如刚刚的例子:

插图

在程序中,从第2行到最后一行,都是在打印,这样很容易就能看明白的代码就没有必要每一行都写注释了。

(2)不要写废话,简单明了就可以了。

(3)不要写错误的注释,写注释一定要认真,错误注释会给自己和别人带来困扰。

(4)不要把真正的代码给注释掉了。

插图

如果是这样那就糟糕了,你把真实的代码print(""也给

Hello World!)注释掉了,那么程序将什么都没有了。

插图

注释回顾

(1)单行注释:通过#在代码后面或者上面添加注释。

(2)多行注释:通过单引号或者双引号添加注释。

(3)注释的要与不要。

添加注释

理解这段代码,并给它添加注释,让别人看了你的注释就能理解这段代码。

插图

第10章 警报,警报,发现异常

插图

程序执行过程中会遇到各种各样的问题,程序会报错、中断执Python行。就好比电动玩具突然停止了,显然玩具出现故障了。这时玩具屏幕上出现提示:电量不足,请充电。有了这段提示,我们就能快速

“”定位问题。

我们不仅要能读懂的错误提示,同时也需要为我们的程序设置

Python合适的异常提醒。这里把异常处理称为守护者。

第课:阅读错误

阅读异常

有这样一段代码,它要将列表中的最后一个数字打印N遍,N等于列表的长度。但是这段代码有3处错误,一起通过报错来排查它们。

插图

运行程序报错:SyntaxError expected':'(语法错误,红色位置应为:)。

插图
插图

给for循环加上:。

插图

运行程序报错:SyntaxError Missing parentheses is call to'print'. Did you mean print(...)?(缺少括号是对print的调用。你指的是print(…)函数吗?)

插图
插图

给print函数加上()。

插图

运行程序报错:IndexError:list index out of range(索引错误:列表索引超出范围)。

列表的索引是从0开始的,最后一个数字的索引是9。

调整索引。

插图

运行程序一切正常。