Python 的文档字符串(docstring)是用于描述模块、类、方法或函数功能的一段注释。它通常位于定义这些对象的代码块的开头,用三个引号(单引号或双引号)包围。
编写好的文档字符串应遵循以下原则:
- 简洁明了:尽量使用简短的句子和清晰的语言来描述功能。
- 完整性:确保文档字符串涵盖了所有重要的信息,如参数、返回值和异常等。
- 正确性:确保文档字符串中的描述与实际功能一致。
- 格式规范:遵循PEP 257规范,使用 reStructuredText 风格编写文档字符串。
以下是一个简单的例子:
def add(a, b):
"""
计算两个数的和。
参数:
a -- 第一个加数
b -- 第二个加数
返回:
两个数的和
"""
return a + b