小码农

趣味编程-面向每个人的创意编程

Python的注释怎么写

avatar 2022-12-20 21:54 435次浏览 0 条评论 Python

什么地方需要注释

 

可以在程序的任何地方写注释。一般情况,变量的定义、类的属性、类的方法、算法设计的主要思路、类的作用等需要写注释。

 

当然,也不是处处都要写注释,处处写注释反而影响了程序的阅读。

 

Python中的注释

 

在Python中提供了两种注释方法,分别是单行注释和多行注释。这一点与其他编程语言(如Java,C#等)没有区别。

 

Python中的单行注释使用”#”字符来开启一行注释。而Python中的多行注释使用一对三个英文单引号或一对三个连写的英文双引号来表示。

 

Python

 

Python中的单行注释

 

“#”字符后的内容为注释内容,且该符号仅对一行起作用。

 

下面是Python中单行注释的一个例子。

 

#这里是一个单行注释
print("翔宇亭IT乐园,百家号")

 

 

num = 8 #定义一个变量存储一个数
if( % 2 == 0): #如果余数为0
print("是偶数。")
else: #否则为奇数
print("是奇数。")

 

Python中的多行注释

 

多行注释使用一对三个连写的单引号开始,并以三个连写的单引号结束。当然双引号也是可以的。如下面这个例子就是多行注释的情况。

 

'''
输入一个年份是否为闰年
程序设计:翔宇亭IT乐园
日期:2020-04-12
'''

def isLeapYear():
#函数的执行语句

 

在上面这个例子中,单引号也可以换成双引号,要注意,单引号或双引号必须使用英文半角的。

 

写注释时一些注意事项

 

在一些实践中,程序注释内容包含程序本身的作用的描述、程序的编写者信息、程序的编写时间、修改时间、修改内容等。

 

注意事项

 

单行注释可以放在一行程序的后面,也可以放在一行程序的上面,但是程序行较长时放在后面不够理想。

 

尽量使注释的风格保持一致,使阅读者能够顺畅地读取程序。

发表评论