Python中docstring文档的写法

该写法根据Python的PEP 257文档总结。
类的函数称为方法（method），模块里的函数称为函数（function）

每一个包，模块，类，函数，方法都应该包含文档，包括类的__init__方法
包的文档写在__init__.py文件中
文档有单行文档和多行文档
单行文档：
不要重复函数的声明语句，例如：function(a, b) -> list
指明做什么和返回什么，例如Do X and return a list.
使用三引号，方便换行
多行文档：
如果模块是一个脚本，也就是单文件程序，模块的文档应该写明脚本的使用方法
模块的文档需要写明包含的类，异常，函数
如果是包，在__init__.py中，写明包里面包含的模块，子包
如果是函数或类方法，应该写明函数或方法的作用，参数，返回，副作用，异常和调用的限制等
如果是类，写明类的行为，和实例参数，构造方法写在__init__中
使用三引号，而且两个三引号都应该单独成行
单行例子：

'''
遇到问题没人解答？小编创建了一个Python学习交流QQ群：857662006 寻找有志同道合的小伙伴，
互帮互助,群里还有不错的视频学习教程和PDF电子书！
'''
def function(a, b):"""Do X and return a list."""

多行例子：

def complex(real=0.0, imag=0.0):"""Form a complex number.Keyword arguments:real -- the real part (default 0.0)imag -- the imaginary part (default 0.0)"""if imag == 0.0 and real == 0.0:return complex_zero...

Python中docstring文档的写法相关推荐

python中的文档字符串(docString)
python中的文档字符串(docString) - 泥土 - 博客园 python中的文档字符串(docString) Posted on 2009-02-19 15:27 泥土阅读(2122) ...
python如何读取公共盘的文档_如何使用 Sphinx 给 Python 代码写文档 | Linux 中国
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka Python 代码可以在源码中包含文档.这种方式默认依靠 docstring ...
python代码_如何使用 Sphinx 给 Python 代码写文档
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka(作者) Python 代码可以在源码中包含文档.这种方式默认依靠 docst ...
查看本机中的python第三方库文档
[转载] 原文链接:https://blog.csdn.net/weixin_43936250/article/details/105251049 本机系统为win10,在使用python编程的过程中 ...
孤荷凌寒自学python第五十四天使用python来删除Firebase数据库中的文档
孤荷凌寒自学python第五十四天使用python来删除Firebase数据库中的文档 (完整学习过程屏幕记录视频地址在文末) 今天继续研究Firebase数据库,利用google免费提供的这个数据库 ...
Python提取Word文档中所有超链接地址和文本
使用Python扩展库python-docx操作Word文档的相关文章,可以阅读: Python批量导入图片到Word文件 Python查找Word文件中红色和加粗的文字(附元宵节送书活动中奖名单) ...
python docx 合并文档图片_Python检查Word文件中包含特定关键字的所有页码
推荐教材:<Python程序设计基础与应用>(ISBN:9787111606178),董付国,机械工业出版社图书详情:配套资源:用书教师可以联系董老师获取教学大纲.课件.源码.教案.考试系 ...
Python3-word文档操作（五）：利用python修改word文档中的表格数据
1. 简介: 本篇继续学习python操作word文档的相关知识.本篇主要学习: 1)如何获取一个已经存在文档中的表格的内容: 2)如何修改一个已经存在文档中的表格的内容: 2. 获取word文档中的 ...
python生成word文档的表格_2018-10-04 [日常]用Python读取word文档中的表格并比较
演示如下. 两个简单的word文档, 各有一个表格: 读取文档中的表格到列表(为演示只对单列表格操作): import docx def 取表格(文件名): 文件 = docx.Document(文件 ...

Python中docstring文档的写法

Python中docstring文档的写法相关推荐

最新文章

热门文章