[规范编程]注释篇-函数注释

纠结，自己写的脚本，隔1-2天自己再看，好费劲，还以为那个高手写的- -... 学下别人的规范编程吧

下面为一个例子
注释准则：
lv1 写函数，或者整体目的
lv2 注释变量内容；变量类型；操作过程
lv3 注释变量内复杂数据姐； 如 dict{ key1:[start_pos,end_pos] ,key2:[start_pos,end_pos],...}
lv4 注释可能意外；python版本不兼容性，特殊用法

#三引号的 第一行注意缩进，到最后三引号前为一个整体，其他行不用缩进

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__)  

转载自：
编程规范之注释篇