在Python中,可以使用文档字符串(docstring)来为函数、方法、类或模块添加说明文档。文档字符串应该使用三重引号(‘’')或双重引号(“”")来包裹,并在函数、方法、类或模块的开头添加。
以下是书写规范的文档字符串示例:
def add(a, b):
"""
This function adds two numbers.
Parameters:
a (int): The first number to be added.
b (int): The second number to be added.
Returns:
int: The sum of the two numbers.
"""
return a + b
在上面的示例中,文档字符串包含了函数的说明、参数说明和返回值说明,这样可以让其他开发者更容易理解函数的作用和用法。在编写代码时,建议添加规范的文档字符串,以提高代码的可读性和可维护性。