Python常用函数--文档字符串DocStrings

Python 有一个甚是优美的功能称作python文档字符串（Documentation Strings），在称呼它时通常会使用另一个短一些的名字docstrings。DocStrings 是一款你应当使用的重要工具，它能够帮助你更好地记录程序并让其更加易于理解。令人惊叹的是，当程序实际运行时，我们甚至可以通过一个函数来获取文档！
案例（保存为 function_docstring.py）：

def print_max(x, y):'''打印两个数值中的最大数。这两个数都应该是整数'''# 如果可能，将其转换至整数类型x = int(x)y = int(y)if x > y:print(x, 'is maximum')else:print(y, 'is maximum')print_max(3, 5)
print(print_max.__doc__)

输出：

$ python function_docstring.py
5 is maximum
打印两个数值中的最大数。这两个数都应该是整数

它是如何工作的

函数的第一行逻辑行中的字符串是该函数的文档字符串（DocString）。这里要注意文档字符串也适用于后面相关章节将提到的python模块（Modules）与python类（Class）。
该文档字符串所约定的是一串多行字符串，其中第一行以某一大写字母开始，以句号结束。第二行为空行，后跟的第三行开始是任何详细的解释说明。5在此强烈建议你在你所有重要功能的所有文档字符串中都遵循这一约定。
我们可以通过使用函数的 __doc__（注意其中的双下划綫）属性（属于函数的名称）来获取函数 print_max 的文档字符串属性。只消记住 Python 将所有东西都视为一个对象，这其中自然包括函数。我们将在后面的类（Class）章节讨论有关对象的更多细节。
如果你曾使用过 Python 的 help() 函数，那么你应该已经在python教程中了解了文档字符串的用途了。它所做的便是获取函数的 doc 属性并以一种整洁的方式将其呈现给你。你可以在上方的函数中尝试一下——只需在程序中包含 help(print_max) 就行了。要记住你可以通过按下 q 键来退出 help。

自动化工具可以以这种方式检索你的程序中的文档。因此，我强烈推荐你为你编写的所有重要的函数配以文档字符串。你的 Python 发行版中附带的 pydoc 命令与 help() 使用文档字符串的方式类似。

总结

我们已经了解了许多方面的函数，但我们依旧还未覆盖到所有类型的函数。不过，我们已经覆盖到了大部分你每天日常使用都会使用到的 Python 函数。
接下来，我们将了解如何创建并使用 Python 模块。

转载于:https://www.cnblogs.com/yuanrenxue/p/10683249.html

Python常用函数--文档字符串DocStrings相关推荐

python中的文档字符串(docString)
python中的文档字符串(docString) - 泥土 - 博客园 python中的文档字符串(docString) Posted on 2009-02-19 15:27 泥土阅读(2122) ...
Python笔记：文档注释docstrings, 让函数更易读懂
文档 docstrings 文档字符串是一种注释,用于解释函数的作用以及使用方式,文档字符串用三个引号引起来: def population_density(population, land_area ...
python - 官方简易文档篇（1）常用、函数
Python Tutorial, 发布 3.8.4rc1 tutorial.pdf 刚总结完str的一些细节,其中还有很多关于类的自定义的因为没有接触过,所以还不知道如何去用,但是再菜鸟教程上看到一个 ...
这个VS Code扩展可以自动生成Python文档字符串
机器之心报道编辑:魔王该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
利用CodeBERT，这个VS Code扩展可以自动生成Python文档字符串
点击上方"AI遇见机器学习",选择"星标"公众号重磅干货,第一时间送达来自:机器之心该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现 ...
python oop 继承_oop-在Python中继承方法的文档字符串
oop-在Python中继承方法的文档字符串我有一个带有文档字符串的OO层次结构,它需要与代码本身一样多的维护. 例如., class Swallow(object): def airspeed(s ...
vscode python 自动补全_利用CodeBERT，这个VS Code扩展可以自动生成Python文档字符串...
机器之心报道编辑:魔王该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
函数小知识点（文档字符串，闭包等）
1 文档字符串(Documentation Strings) 一般被称为docstring,一款你应当使用的重要工具,它能够帮助你更好地记录程序并让其更加易于理解.令人惊叹的是,当程序实际运行时,我们 ...
Python文档字符串生成器：基于CodeBERT，支持Google、Numpy等多种输出格式
木易发自凹非寺量子位报道 | 公众号 QbitAI 又一款懒人神器问世了: Visual Studio Code的扩展,基于CodeBERT的Python文档字符串生成器. 看来现在,这群偷 ...

Python常用函数--文档字符串DocStrings

Python常用函数--文档字符串DocStrings相关推荐

最新文章

热门文章