无名阁,只为技术而生。流水不争先,争的是滔滔不绝。

(python doc) Python 文档属性(__doc__)的添加与查看 Python __doc__ 属性使用 全网首发(图文详解1)

前沿技术 Micheal 2个月前 (05-27) 31次浏览 已收录 扫描二维码

(python doc) Python 文档属性(doc)的添加与查看

Python的 __doc__ 属性是一种特殊的属性,被用于存储关于函数,方法或对象的字符串文档注释。这在代码开发中对于解释和理解代码有重要作用。以下是如何添加及查看的具体步骤:

Python中,每个模块,类或函数和方法都有一个特殊的内置属性__doc__。这个属性保存的是模块,类或函数的开始部分的第一个非空行上置字符串(称之为docstring)。使用help()函数,或者直接查看这个__doc__属性都可以看到这个docstring。

添加__doc__

在定义模块、类或函数时,在其开始部分的首行添加一个字符串,即定义了__doc__。例如,定义一个函数add,并给它添加一个docstring。

def add(a, b):
    """
    这是一个加法函数。# 这就是__doc__
    功能:实现两个数的加法运算
    参数:a-第一个要相加的数,b-第二个要相加的数
    返回值:两个数的和
    """
    return a + b

查看__doc__

直接调用打印函数print(),对__doc__进行查看。例如,查看上面add函数的__doc__

print(add.__doc__)

结果将会打印出docstring:

这是一个加法函数。
功能:实现两个数的加法运算
输入:a-第一个要相加的数,b-第二个要相加的数
输出:两个数的和

除了这种方式外,还可以使用内置的help()函数:

help(add)

help()还会打印出函数签名和位置等信息。

利用__doc__help()在开发中编写和查看注释非常方便,同时也使用于团队合作与他人分享你的代码。
(transpose函数) 详解Numpy transpose()(转置数组)函数的作用与使用方法 转置数组:Python Numpy 库中的 transpose() 函数 全网首发(图文详解1)
(迭代器) python中cycle函数的作用与使用方法 Python itertools cycle 函数介绍 全网首发(图文详解1)

喜欢 (0)
[]
分享 (0)
关于作者:
流水不争先,争的是滔滔不绝