python之文档字符串的用法

这篇文章主要介绍python之文档字符串的用法，文中介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们一定要看完！

一、文档字符串定义

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

<span style="font-size:24px;">def add(a,b):

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

    sum = a+b

    return sum</span><span style="font-size:18px; ">

 </span>

二、文档字符串的用法

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

以上是“python之文档字符串的用法”这篇文章的所有内容，感谢各位的阅读！希望分享的内容对大家有帮助，更多相关知识，欢迎关注亿速云行业资讯频道！