我们该如何添加注释?

当然,添加注释的最大作用还是提高程序的可读性 !很多时候,笔者宁愿自己写一个应用,也 不愿意去改进别人的应用,没有合理的注释是一个重要原因 。 虽然良好的代码可自成文挡,但我们永远也不清楚今后读这段代码的人是谁,他是否和你有相 同的思路。或者一段时间以后,你自己也不清楚当时写这段代码的目的了。通常而言,合理的代码 注释应该占源代码的 1/3 左右。 Python 语言允许在任何地方插入空字符或注释,但不能插入到标识符和宇柏:串中间。 Python 源代码的注释有两种形式: 〉单行注释 〉多行注释 Python 使用井号(#)表示单行注释的开始,跟在“#”号后面直到这行结束为止的代码都将 被解释器忽略。单行注释就是在程序中注释一行代码,在 Python 程序中将井号(#)放在需要注释 的内容之前就可以了 。 多行注释是指一次性将程序中的多行代码注释掉,在 Python 程序中使用三个单引号或三个双 引号将注释的内容括起来。 下面代码中增加了单行注释和多行注释。
程序清单: codes\02\2. 1\comment_test.py
#这是一行简单的注释 pri口t (”Hello World !” ) 
这里面的内容全部是多行注释 Py th。n 语言真的很简单
# print (”这行代码被注释了,将不会被编译、执行!”)
这是用三个双引号括起来的多行注释 Python 同样是允许的
上面程序代码中粗体字部分就是程序的注释,这些注释对程序本身没有任何影响,这些注释内 容的主要作用就是“给人看”,向人提供一些说明信息, Python 解释器会忽略这些注释内容。

简单说:

1:单行注释就是在代码前面加#

2:多行注释就是在代码前面和后面分别加

(1)三个单引号'''    '''(在英文状态下比较容易输入)

(2)三个双引号""""""(在英文状态下比较容易输入)

3:这样做的好处是:

(1)比较能够让人读懂,如果有人希望能够读懂你的代码的话,通过看你的注释就可以了。

看到很多人,宁可自己写,也不看别人的,真的是够了。

(2)添加注释也是调试程序的一个重要方法。如果觉得某段代码可能有问题,可以先把这段 代码注释起来,让 Python 解释器忽略这段代码,再次编译、运行,如果程序可以正常执行,则可 以说明错误就是由这段代码引起的,这样就缩小了错误所在的范围,有利于排错:如果依然出现相 同的错误,则可以说明错误不是由这段代码引起的,同样也缩小了错误所在的范围。
 

发布了45 篇原创文章 · 获赞 0 · 访问量 532

猜你喜欢

转载自blog.csdn.net/tainwaifeixian/article/details/103258595