python中的文档字符串(docString)

转载 2011年01月17日 03:56:00

Python有一个很奇妙的特性,称为 文档字符串 ,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可以在程序运行的时候,从函数恢复文档字符串!

使用DocStrings

#!/usr/bin/python
# Filename: func_doc.py

def printMax(x, y):
    '''Prints the maximum of two numbers.

    The two values must be integers.'''
    x = int(x) # convert to integers, if possible
    y = 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中的文档字符串

我们在使用def 关键字定义一个函数时,其后必须跟有函数名和包括形式参数的圆括号。函数体的下一行开始,必须是缩进的。函数体的第一行可以是字符串,这个字符串就是文档字符串(documentation s...

doxygen + doxypypy + docstring 生成python文档

虽然doxygen声称可以同时支持两种风格的python注释,原生的docstring和类似java doc风格的##。但实际对原生的docstring支持并不好。这里介绍了一个开源的doxypypy...

飘逸的python - 代码即文档docstring

什么是docstring在软件工程中,其实编码所占的部分是非常小的,大多是其它的事情,比如写文档。文档是沟通的工具。 在python中,比较推崇在代码中写文档,代码即文档,比较方便,容易维护,直观,...

Python写自动化之使用sphinx提取Python代码docstring

在使用Python时,一个特性是Python中的文档字符串,文档字符串又称为DocStrings。使用文档字符串可以为我们的模块、类、函数添加说明性文档,使程序更容易被看懂。这好像和其他语言中的注释没...

python 文档字符串 关键字参数 默认参数 传递函数和lambda函数

python 文档字符串 默认参数 关键字参数 传递函数 lambda函数

python 格式化字符串(官方文档)

A conversion specifier contains two or more characters and has the following components, which must ...

Python 文档化字符串

Python有一个很奇妙的特性,称为 文档字符串 ,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可...

学习python的第三十天-参数,return语句,文档字符串

默认参数值在定义函数的时候我们需要使用默认参数值。可以在函数定义的形参名后加上赋值运算符=和默认值,从而给形参指定默认参数值...
  • A_lPha
  • A_lPha
  • 2016年12月07日 23:18
  • 796

python打印文档字符串

def printMax(x,y):     '''打印两个数中的最大值。     连个值必须是整数(徐阳)。'''     x =int(x)  #如果有可能,转为整数     y=int(...

python---函数(返回整型最大/最小值、返回字符串最长的串、函数返回任意的module的帮助文档内容、读取目录下内容、)

python—函数(返回整型最大/最小值、返回字符串最长的串、) 习题:1.定义一个方法 func,该func可以引入任意多的整型参数,结果返回其中最大与最小的值。使用元组的求解最大值/最小值的函数...
  • xwbk12
  • xwbk12
  • 2017年11月04日 15:34
  • 128
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:python中的文档字符串(docString)
举报原因:
原因补充:

(最多只允许输入30个字)