Python学习-21.Python的代码注释

在Python中有两种注释，一种是普通注释，另一种是文档注释。

普通注释是使用#开头

1 print('output something') # here is comment

而Python中多行注释也是使用#

1 # comment 1
2 # comment 2
3 # comment 3

而文档注释则是使用英文的三个单引号

1 def Print(msg):
2     '''输出字符串
3     msg: 字符串内容
4     '''          
5     print(msg)

而在我们使用这个Print函数的时候VS的智能提示也会显示出文档注释

需要注意的是

1 s = '''
2    abcd
3    efgh
4 '''

这种情况下，'''代表多行文本。即'''代表文档注释的情况下是不作为任何函数参数及不被赋值的情况下。