python之文档字符串的用法
创始人
2024-11-21 03:01:38
0次

一、文档字符串定义

文档字符串（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

上一篇：python爬虫中怎么创建任务进程

下一篇：python编程中如何添加注释

相关内容

热门资讯

空调连续工作多久需要停机休息 空调连续工作的时间取决于多个因素，包括空调的型号、功率、使用环境和维护情况等。一般来说，空调可以连续...
空调哪个符号是除湿的 空调除湿功能通常用一个水滴形状的符号表示。不同品牌和型号的空调遥控器可能会有所差异，但一般来说，除湿...
格力空调多长时间加一次氟利昂 1、一般情况下，空调对氟利昂的使用量是非常小的，所以在空调使用了四年左右的时候再考虑加也没问题。2、...
空调用多长时间需要加氟一次 一般情况下是五年。当出现以下这几种情况时，空调才需要加氟。1、空调的室内机和室外机各有两个接口，当接...
格调生活·C标思享荟：卡萨帝在... 9月12日的郑州龙湖金融岛，夜风轻拂，灯光璀璨。“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑...
品牌价值破千亿、高端份额持续领... 9月12日，“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑州站”在郑州龙湖金融岛举办。2026...
空调主板坏了修800还是换新的 空调主板坏了是修还是换新，需要考虑多个因素，以下是一些建议：1. 维修成本：如果维修费用较低，比如 ...
空调开多久需要休息多长时间 问题：空调开多久需要休息多长时间回答：1、在使用空调的过程中，一般空调开7~8个小时左右需要休息2~...
中央空调多长时间清洗一次 1、一般空调开机前清洗一次即可，空调开机中间时段再清洗一次，空调关机时清洗一次，这样比较合理。2、空...
中央空调氟利昂多久加一次 看空调制热和制冷程度，很多人的观点认为氟利昂必须一年放一次，其实这个观点是错误的，理解上面有点偏差，...