好冷的Python–三引号注释，你的要求为什么这么多

原文链接：http://www.juzicode.com/archives/779

我们知道在Python中的注释可以用“#”后面带一段不跨行的字符串，像这样的:

def func():
    #这是一行注释，不能换行，与pass语句缩进一致
    pass

也可以用三引号包含一段多行的打印，比如用在函数定义的下方，表明函数用途、入参含义的一段注释:

def func(name,id):
    '''
    这是一段注释，打印name和id内容
    name:名字
    id:编号
    '''
    print(name,id)
    

func('桔子code','2020')

#带的单行注释对缩进是没有要求的，可以顶格写，前面也可以有一个或多个空格，也可以跟在语句后面。

def func():
#这是一行注释，不能换行，顶格写
    pass

def func():
    pass #这是一行注释，不能换行，写在语句后面

那对于三引号的注释是否也可以在函数定义语句后面顶格写呢，我们将上面这段代码修改下，让第一个的前置三引号顶格写，再运行下这个py文件:

def func(name,id):
'''
这是一段注释，打印name和id内容
name:名字
id:编号
''' 
    print(name,id)
    

func('桔子code','2020')

==========结果:
  File "comment2.py", line 7
    '''
这是一段注释，打印name和id内容
name:名字
id:编号
'''
    ^
IndentationError: expected an indented block

或者将一段三引号注释写入语句后面试试：

def func(name,id):'''
这是一段注释，打印name和id内容
name:名字
id:编号
''' 
    print(name,id)
    

func('桔子code','2020')

==========结果:
  File "comment4.py", line 7
    print(name,id)
    ^
IndentationError: unexpected indent

在函数定义语句后面紧跟着写三引号注释或者函数定义的下一行顶格写时，都出错了！发生了什么？ 看下提示内容，大意都是缩进格式不正确。既然是作为注释，为什么要考虑缩进呢？三引号注释为什么不能用在函数的注释中顶格写或者紧跟函数定义语句呢？

先看下一对三引号是表示什么含义，打印出它的类型和内容：

a='''
这是一段注释，打印name和id内容
name:名字
id:编号
''' 
print('type(a):',type(a))
print('a:',a)

==========结果:
type(a): <class 'str'>
a:
这是一段注释，打印name和id内容
name:名字
id:编号

原来一对三引号表示的是一个字符串，在《好冷的Python–pass和它的备胎们》一文中，我们知道可以用一个字符串代替pass语句作为占位语句，而占位语句对缩进是有要求的。一对三引号字符串作为注释时就可以看成一个占位语句，所以对它的缩进格式是有要求的！

 

---

如果你想及时接收到更冷的Python知识，记得微信扫一扫关注“桔子code”。