Python中docstring文档的写法

枫铃4年前 (2021-07-09)Python282

该写法根据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同步windows和linux文件

写python脚本的初衷,每次在windows编辑完文件后,想同步到linux上去,只能够登录服务器,...

爬虫基本原理

爬虫基本原理 一、爬虫是什么? 百度百科和维基百科对网络爬虫的定义:简单来说爬虫就是抓取目标网站内容的工具,一般是根据定义的行...

Django 函数和方法的区别

函数和方法的区别 1、函数要手动传self,方法不用传 2、如果是一个函数,用类名去调用,如果是一个方法...

Django 知识补漏单例模式

单例模式:(说白了就是)创建一个类的实例。在 Python 中,我们可以用多种方法来实现单例模式&#x...

Django基础知识MTV

Django简介 Django是使用Python编写的一个开源Web框架。可以用它来快速搭建一个高性能的网站。 Django也是一个MVC框架。但是在Dj...

Python mysql 索引原理与慢查询优化

一 介绍 为何要有索引? 一般的应用系统,读写比例在10:1左右,而且插入操作和一般的更新操作很少出现性能问题,...

发表评论

访客

看不清,换一张

◎欢迎参与讨论,请在这里发表您的看法和观点。