python中的文档字符串(docString)

python中的文档字符串(docString) - 泥土 - 博客园

python中的文档字符串(docString)

Posted on 2009-02-19 15:27 泥土阅读(2122) 评论(0) 编辑收藏
Python有一个很奇妙的特性，称为文档字符串，它通常被简称为 docstrings 。DocStrings是一个重要的工具，由于它帮助你的程序文档更加简单易懂，你应该尽量使用它。你甚至可以在程序运行的时候，从函数恢复文档字符串！

使用DocStrings
#!/usr/bin/python
# Filename: func_doc.pydef printMax(x, y):'''Prints the maximum of two numbers.The two values must be integers.'''x = int(x) # convert to integers, if possibley = int(y)if x > y:print x, 'is maximum'else:print y, 'is maximum'printMax(3, 5)
print printMax.__doc__ 
输出
$ python func_doc.py
5 is maximum
Prints the maximum of two numbers.The two values must be integers. 
它如何工作

在函数的第一个逻辑行的字符串是这个函数的文档字符串。

文档字符串的惯例是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开始是详细的描述。强烈建议你在你的函数中使用文档字符串时遵循这个惯例。

你可以使用__doc__（注意双下划线）调用printMax函数的文档字符串属性（属于函数的名称）。请记住Python把每一样东西都作为对象，包括这个函数。

如果你已经在Python中使用过help()，那么你已经看到过DocStings的使用了！它所做的只是抓取函数的__doc__属性，然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)。记住按q退出help。

自动化工具也可以以同样的方式从你的程序中提取文档。因此，我强烈建议你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令，与help()类似地使用DocStrings。

python中的文档字符串(docString)相关推荐

Python常用函数--文档字符串DocStrings
Python 有一个甚是优美的功能称作python文档字符串(Documentation Strings),在称呼它时通常会使用另一个短一些的名字docstrings.DocStrings 是一款你应 ...
vscode python 自动补全_利用CodeBERT，这个VS Code扩展可以自动生成Python文档字符串...
机器之心报道编辑:魔王该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
python oop 继承_oop-在Python中继承方法的文档字符串
oop-在Python中继承方法的文档字符串我有一个带有文档字符串的OO层次结构,它需要与代码本身一样多的维护. 例如., class Swallow(object): def airspeed(s ...
这个VS Code扩展可以自动生成Python文档字符串
机器之心报道编辑:魔王该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
利用CodeBERT，这个VS Code扩展可以自动生成Python文档字符串
点击上方"AI遇见机器学习",选择"星标"公众号重磅干货,第一时间送达来自:机器之心该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现 ...
python如何读取公共盘的文档_如何使用 Sphinx 给 Python 代码写文档 | Linux 中国
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka Python 代码可以在源码中包含文档.这种方式默认依靠 docstring ...
python代码_如何使用 Sphinx 给 Python 代码写文档
最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka(作者) Python 代码可以在源码中包含文档.这种方式默认依靠 docst ...
python html 语法高亮,在Python中使用doxygen样式文档字符串的Vim语法高亮显示
我开始使用doxygen来生成我的Python代码的文档. 我使用doxypy过滤器来预处理Python文档字符串. 我的目标是在Python中有一个很好的语法突出显示doxygen注释. 在专用.d ...
Python文档字符串生成器：基于CodeBERT，支持Google、Numpy等多种输出格式
木易发自凹非寺量子位报道 | 公众号 QbitAI 又一款懒人神器问世了: Visual Studio Code的扩展,基于CodeBERT的Python文档字符串生成器. 看来现在,这群偷 ...

python中的文档字符串(docString)

python中的文档字符串(docString)

使用DocStrings

输出

它如何工作

python中的文档字符串(docString)相关推荐

最新文章

热门文章