Python 是一門常用的編程語言,注釋是代碼中不可或缺的一部分。在 Python 中,注釋可以使用單行注釋、多行注釋和語句塊注釋。本文將著重介紹語句塊注釋。
def add(a, b): """ This is a docstring for function add. This function adds two numbers. """ sum = a + b return sum
如上代碼中,三個雙引號之間的文本就是語句塊注釋,也稱為文檔字符串。
語句塊注釋適用于注釋模塊、類、函數等代碼塊。文檔字符串的第一行通常是對代碼塊進行簡要描述。在第一行后面,可以添加更詳細的描述和其他任何細節信息。在使用函數和模塊時,可以通過 help() 函數來查看相應的文檔字符串。
def say_hello(name): """ This function prints a greeting message to the specified name. :param name: the name to greet. :type name: str """ print("Hello, " + name + "!")
在上面的代碼中,文檔字符串包含了一個參數列表。在參數的名稱后面,可以通過冒號來說明參數的類型和作用。這樣的注釋可以幫助其他程序員更好地理解代碼的含義和使用。
總之,語句塊注釋是 Python 中非常有用的一種注釋方式。合理使用注釋不僅可以讓代碼可讀性更高,還可以方便其他程序員更好地了解和使用代碼。