python doc_python中的_doc_是什么

文档字符串。注意,是 __doc__ ,前后各两个下划线。

一般而言,是对函数/方法/模块所实现功能的简单描述。但当指向具体对象时,会显示此对象从属的类型的的文档字符串。(示例见以下 a.__doc__)

>>> str.__doc__

"str(string[, encoding[, errors]]) -> str\n\nCreate a new string object from the given encoded string.\nencoding defaults to the current default string encoding.\nerrors can be 'strict', 'replace' or 'ignore' and defaults to 'strict'."

>>> import math

>>> math.__doc__

'This module is always available. It provides access to the\nmathematical functions defined by the C standard.'

>>> a = [1]

>>> a.count.__doc__

'L.count(value) -> integer -- return number of occurrences of value'

>>> a.__doc__

"list() -> new empty list\nlist(iterable) -> new list initialized from iterable's items"

为自定义的函数创建 __doc__ 的方法示例:

>>> def func():

"""Here's a doc string"""

pass

>>> func.__doc__

"Here's a doc string"

更详细的资料请参考 Python Tutorial 4.7.6 Documentation Strings.

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值