Python3 爬阶梯 | 为什么通过 help() 就能获取到代码的相关说明?

我们在使用 Python 的时候,不管是内置的模块,还是我们引用的第三方的模块,当我们对它们的具体使用不是很清楚的时候,我们就会使用 help() 或者 __doc__ 来获取相关的帮助文档, 比如我们要看看 print 这个函数的说明:

这时候我们可以看到 print 函数的介绍:

其实这就是 Docstring,今天要跟你讲讲这个玩意如何去写,除了知道如何去阅读别人的文档介绍之外,自己也要知道怎么写,这不管是你以后去开源一个项目还是跟团队合作,都是需要写的。

什么是 Docstring 呢?其实就是

本文隐藏内容 登陆 后才可以浏览
我这里选择的是 NumPy 的模板,那么下次你要写 Docstring 的时候就是这样了:

ok,以上就是 Docstring 的使用。

发表评论

电子邮件地址不会被公开。 必填项已用*标注