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...
  • wgw335363240
  • wgw335363240
  • 2014年05月13日 15:43
  • 7395

python整理笔记3---__doc__(文档字符串)

1、定义 如果将一个字符串作为函数的第一部分,而没有名称去引用它,python将它存储在函数中,以便以后可以引用它,这个字符串通常叫做docstring,是documentation string(文...
  • xiaobote_
  • xiaobote_
  • 2015年05月11日 18:53
  • 1422

python中的文档字符串(docString)

Python有一个很奇妙的特性,称为 文档字符串 ,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可以在程序...
  • ac540101928
  • ac540101928
  • 2018年01月05日 15:54
  • 51

一个python文档字符串处理小例子

一直看英文的技术文档都有恐惧症,看资料时总是优先找中文的,但是不得不说,英文的各种资料是最新、最完整的,要想成为一个更好的程序员,看英文技术文档是应该的。我的英文并没有自己想象中的那么渣,大学英语四六...
  • jielong39
  • jielong39
  • 2017年07月02日 16:57
  • 158

Python对象的文档字符串(DocString):__doc__的写法和输出方法

Python有个特性叫做文档字符串,即DocString,这个特性可以让你的程序文档更加清晰易懂,在python的系统文件里,也都在使用这个特性。因此推荐每个Python爱好者都使用它。       ...
  • houbin01
  • houbin01
  • 2016年11月24日 22:11
  • 2107

Python docstring文档字符串

使用DocStrings Python有一个很奇妙的特性,称为 文档字符串,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽...
  • jiyanfeng1
  • jiyanfeng1
  • 2012年10月27日 06:10
  • 11011

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

A conversion specifier contains two or more characters and has the following components, which must ...
  • u012223913
  • u012223913
  • 2016年07月18日 16:01
  • 502

Python对象的文档字符串(DocString):__doc__的写法和输出方法

Python有个特性叫做文档字符串,即DocString,这个特性可以让你的程序文档更加清晰易懂,在python的系统文件里,也都在使用这个特性。因此推荐每个Python爱好者都使用它。       ...
  • qq_37811638
  • qq_37811638
  • 2018年01月18日 20:27
  • 27

Python中的文档字符串的作用

Python中的文档字符串的作用 转载自:http://blog.csdn.net/aqxy0912/article/details/6145635 Python有一个很奇妙的特性,称为 文档字符...
  • liu_ben_qian
  • liu_ben_qian
  • 2012年07月01日 14:23
  • 4191

Python随笔之文档字符串(DocStrings)

在Python中有一个奇妙的特性,文档字符串,又称为DocStrings。用它可以为我们的模块,类,函数添加说明性的文字,使程序易读易懂,更重要的是可以通过Python自带的标准方法将这些描述性文字信...
  • chris_mao
  • chris_mao
  • 2011年09月07日 13:34
  • 8426
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:python中的文档字符串(docString)
举报原因:
原因补充:

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