在Python中,文档字符串(docstring)是一种为函数、类或模块提供说明性文档的方式。它们通常位于定义的顶部,并用三引号('''
或 """
)括起来。要从单独的脚本访问这些文档字符串,可以使用内置的 __doc__
属性。
以下是一个简单的示例,展示了如何定义和访问文档字符串:
# example.py
def add(a, b):
"""
这个函数用于计算两个数的和。
参数:
a (int): 第一个加数
b (int): 第二个加数
返回:
int: 两个数的和
"""
return a + b
class Calculator:
"""
这是一个简单的计算器类。
方法:
add(a, b): 计算两个数的和
"""
def add(self, a, b):
return a + b
# 访问函数的文档字符串
print(add.__doc__)
# 访问类的文档字符串
print(Calculator.__doc__)
# 创建类的实例并访问方法的文档字符串
calc = Calculator()
print(calc.add.__doc__)
这个函数用于计算两个数的和。
参数:
a (int): 第一个加数
b (int): 第二个加数
返回:
int: 两个数的和
这是一个简单的计算器类。
方法:
add(a, b): 计算两个数的和
这个函数用于计算两个数的和。
参数:
a (int): 第一个加数
b (int): 第二个加数
返回:
int: 两个数的和
add
和类 Calculator
都有各自的文档字符串。__doc__
属性可以访问函数、类或方法的文档字符串。add.__doc__
访问了函数 add
的文档字符串。Calculator.__doc__
访问。calc.add.__doc__
访问。文档字符串在以下场景中非常有用:
通过这种方式,你可以轻松地从单独的脚本中访问和使用文档字符串,从而提高代码的可读性和可维护性。
腾讯云GAME-TECH沙龙
云+社区开发者大会 长沙站
云+社区技术沙龙[第14期]
第四期Techo TVP开发者峰会
DBTalk技术分享会
云+社区技术沙龙[第2期]
腾讯云GAME-TECH游戏开发者技术沙龙
云+社区技术沙龙[第27期]
Elastic 中国开发者大会
领取专属 10元无门槛券
手把手带您无忧上云