开发者社区> 问答> 正文

python中__doc__是什么

python中__doc__是什么

展开
收起
云计算小粉 2018-05-10 20:10:50 2466 0
1 条回答
写回答
取消 提交回答
  • 每个对象都会有一个__doc__属性,用于描述该对象的作用。在一个模块被import时,其文件中的某些特殊的字符串会被python解释器保存在相应对象的__doc__属性中。比如,一个模块有模块的__doc__,一个class或function也有其对应的__doc__属性。在python中,一个模块其实就是一个.py文件。在文件中特殊的地方书写的字符串就是所谓的docstrings,就是将被放到__doc__的内容。这个“特殊的地方”包括:

    1. 一个文件任何一条可执行的代码之前 #模块的__doc__
    2. 一个类,在类定义语句后,任何可执行代码前#类的__doc__
    3. 一个函数,在函数定义语句后,任何可执行代码前#函数的__doc__

    举个例子:

    use doc 属性

    class MyClass:

    'string.'
    def printSay():
        'print say welcome to you.'
        print 'say welcome to you.'

    print MyClass.__doc__
    print MyClass.printSay.__doc__

    输出结果

    string.
    print say welcome to you.

    2019-07-17 22:22:53
    赞同 展开评论 打赏
问答分类:
问答标签:
问答地址:
问答排行榜
最热
最新

相关电子书

更多
From Python Scikit-Learn to Sc 立即下载
Data Pre-Processing in Python: 立即下载
双剑合璧-Python和大数据计算平台的结合 立即下载