在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
在上面的示例中,文檔字符串包含了函數的說明、參數說明和返回值說明,這樣可以讓其他開發者更容易理解函數的作用和用法。在編寫代碼時,建議添加規范的文檔字符串,以提高代碼的可讀性和可維護性。