Python 在程式碼中加入註解

在Python程式中加入註解說明的方式如下。

單行註解在文字前面加上#。

# 這是單行的註解
print("Hello world")  # 這也是單行註解

在Visual Studio Code (VS Code)的快速鍵為Ctrl + /。

多行註解則是在文字前後用連續三個雙引號(""")或三個單引號(''')包起。

"""
這是多行註解
這是多行註解
"""
'''
這也是多行註解
這也是多行註解
'''

事實上這應該叫作文件說明字串(Docstrings)，寫在module，function，class，method的第一段敘述中，則docstring文字會自動成為該物件的__doc__屬性。

例如下面定義了ㄧ個foo()，並緊接著一行"""這是foo()的說明文字"""，則此行文字敘述即為此foo().__doc__的值。

def foo():
    """這是foo()的說明文字"""
    return None 

print(foo.__doc__)  # 印出「這是foo()的說明文字」

docstring在VS Code的快速鍵為Shift + Alt + A，把要註解的文字區塊選取後在按快速鍵。

• PEP 257 -- Docstring Conventions
• The standard type hierarchy
• Documentation Strings
• Python 3 使用 def 定義函式