Python文档字符串的定义与简单使用

文档字符串的应用场景

在编写大型程序的时候，我们常常会定义很多个函数，有时我们自己也会忘记某个函数是什么功能；在编写面向其他用户的程序时，我们需要明确的告诉用户我们定义的函数是什么功能，这个时候我们可以使用文档字符串。

---

文档字符串的定义语法

文档字符串是定义函数的一个可选功能，定义文档字符串与否并不影响函数本身的运行

定义文档字符串很简单，在函数体的第一行输入文档字符串即可。

def example():
    'wendangzifuchuan'
    pass

文档字符串也可以用" "（双引号）或''' '''（三引号）连接

---

文档字符串的使用

如果使用过python的help()函数就会发现，python的内置函数都可以通过help()函数获得一些简单的说明。而这些说明就定义在文档字符串内。所以文档字符串定义后就可以通过help()函数获取到。

上面的example函数若使用help函数就会返回如下结果：

>>> help(example)
Help on function example in module __main__:

example()
    wendangzifuchuan

---

本文章作为我的学习笔记，若有错误请指正，谢谢！