编程规范之注释篇

编程规范之注释篇

1.函数注释

def sum():
    '''这个是求和函数'''

def mysum(a,b):
'''
这个是求和函数
a为第一个数
b为第二个数
result为a+b的和
return 返回result(a+b的和)
'''
    result=a+b
    return result
result=mysum(2,3)
print(result)

print(mysum.__doc__)   #显示该函数注释内容

2.多行注释(同时也可以作为变量的多行内容赋值）

'''
白日依山尽，
黄河入海流。
欲穷千里目，
更上一层楼
'''
print(__doc__)

3.单行注释

#白日依山尽，
#黄河入海流。
#欲穷千里目，
#更上一层楼

转载于:https://www.cnblogs.com/endmoon/p/9660389.html