python中的注释功能和使用详解

注释的目的:对代码进行说明,增强程序的可读性。

python中的注释常用的有两种:

单行注释
在每一行前加#号,直到这行结束为止的所有内容都是注释

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

样例1

>>> #我的第一个python程序
>>> print("Hello World!")
Hello World!

注释应该简短、贴切、切中要害。
代码行中的注释最多为72个字符。如果您的注释接近或超过了该长度,
则需要将其转变为多行注释。

样例2

>>> #第一行说明
>>> #第二行说明
>>> #第三行说明

多行注释这样太累,换成文件式直接选中想要注释的多行内容再**ctrl+/**搞定。
如果想取消,选中再重复按键即可。
(记事本无此功能,像Sublime Text等IDE都可实现)

多行注释
在要注释的内容前后行加三个单引号或双引号
(建议用三个双引号,三个单引号容易引起冲突)

从技术上讲,这并不是一个注释。它仅仅是一个没有分配给任何变量的字符串,
所以程序不会调用或引用它。
由于它在运行时会被忽略并且不会出现在字节码中,所以它可以有效地充当注释。

样例3
“”"
第一行说明
第二行说明
第三行说明
“”"

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

注意事项:
多行注释不支持嵌套;
当注释符成为字符串的一部分出现时,就不能再将它们视为注释标记。

样例4

>>>print('''Hello World''')
Hello World
>>>print("""I am Chinese!""")
I am Chinese!

注释的其他功能
1,导入编码格式
python2.x程序默认是ASCII编码,如果有中文输入需要编码注释,必须要添加一行声明文件
声明必须放在代码的第一行或第二行。

#coding = utf-8 或者 #coding = gbk 或者 #coding:UTF-8
(Python3的默认编码是UTF-8,可以不用)

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

注释应避免的状况:
1,W.E.T.注释
这类问题可简写为
W.E.T. “wrote everything twice” or “wasted everyone’s time”
D.R.Y. “Don’t Repeat Yours”

样例6
return a #Returns a

2,利用注释来弥补代码
注释有时会反映出您的代码可能存在深层次的问题,注释是试图隐藏代码自身问题的一种方法,
但注释应该支持您的代码,而不是试图弥补它。如果您的代码编写得很糟糕,那么任何注释都不会修复它。

样例7

#输入姓名和年龄并打印
a = input("请输入你的姓名:")		#输入你的姓名
b = input("请输入你的年龄:")		#输入你的年龄
print("你的姓名:{}你的年龄{}".format(a,b))	#打印你的姓名和年龄

通过为变量,函数和集合等指定合理的名称,可使代码变得简单

样例8

your_name = input("请输入你的姓名:")
your_age =	input("请输入你的年龄:")	
print("你的姓名:{}你的年龄{}".format(a,b))

3,避免代码以外的词句

注释里不要出现一些含有政治,人身攻击,粗鲁,负能量的词句。
只写与代码相关的内容。

猜你喜欢

转载自blog.csdn.net/qq_41952762/article/details/108408438