各种帮助文档的写法

什么是 Docstring

其实就是文档字符串,主要就是解释项目中的具体功能使用介绍,项目超详细的使用说明书
通过 help 命令查看 print 函数的使用说明

Docstring 也是在代码里直接写的,与注释不同的在于写法不同,描述的方式不同,Docstring 更多的是描述具体的功能,而注释更多的是解释代码的行为

查看 print 函数源码,得知其 Docstring 的写法如下:

  1. Docstring 应该是在函数定义下的第一行开始声明(类也是如此)

  2. Docstring 应该是用三引号开头三引号结尾

  3. Docstring 第一行的描述尽量简短并且能让人一下子就知道说的是什么

  4. 第二行起需要空行

  5. 每一段描述之间需要有空行

创建一个简单的模块

查看这个模块的帮助文档