python入门：文档字符串

上篇我们说到了能够帮助程序员理解程序编写者的代码的方式是添加注释，可是你知道吗？想写出易于理解的优秀代码，文档字符串也是可以的。这时可能有人就有疑惑了，注释起到解释说明的作用大家通过字面意思可以明白，那文档字符串是什么？怎么起解释的作用呢？别急，下面，我们来介绍以下文档字符串。

一、文档字符串定义

文档字符串（documentation string），通常也称作：docstring。
在函数体的第一行，我们可以使用一对三个单引号（”’）或者一对三个双引号（”””）来定义文档字符串，文档字符串通常第一行以大写字母开头，以句号（.）结束，第二行是空行，第三行开始是详细描述，简单的说就是给函数一个描述。

def add(a,b):

    """this a function to additon"""   #文档字符串

    sum = a+b

    return sum

 

二、文档字符串的用法

1、模块开头，作为整个模块的文档说明；
2、函数/方法的def语句定义后到函数体之间，用于函数/方法说明；
3、类定义的class语句后到类体之间，用于类说明。

三、使用__doc__访问文档字符串

字符串在给函数描述的过程中，需要添加函数功能说明。这个说明可以使用.__doc__（注意前后都是双_）属性，将DocString特性print打印出来。

def inputxy():  
    '''''this is my first test doc'''
    print "hello the word"
inputxy()  
print inputxy.__doc__# print pirntXY's doc

输出内容:

hello the world  
this is my first test doc  
  
Process finished with exit code 0

以上向大家介绍了文档字符串的定义、函数描述、用法和使用__doc__访问文档字符串的方法，小伙伴们应该对文档字符串有一定的了解了吧。python入门并不难，关键是要把基础打实，加油哦~更多python学习推荐：python学习网python基础。