這篇教程將向您展示關(guān)于Python注釋的知識。
注釋就是其字面意思秕豫，即對程序進行補充說明朴艰，但是不影響程序執(zhí)行。注釋使程序更具可讀性和可維護性混移。
Python注釋支持三種注釋方式：
- 單行注釋
- 多行注釋
- 文檔注釋
單行注釋
單行注釋以井號（＃）開頭祠墅，并自動以EOL（行尾）結(jié)束。
>>> # 輸出Hello, World!
... print("Hello, World!")
Hello, World!
注釋與其下方的代碼處于同一縮進級別
>>> def sum(a, b):
... # 計算并返回a + b的值
... return a + b
...
>>> sum(2, 3)
5
多行注釋
Python允許注釋跨越多行歌径。此類注釋稱為多行注釋或塊注釋毁嗦。
要添加多行注釋，使用井號（＃）后跟單個空格開始每一行回铛。也可以將注釋分成段落狗准。只需在每個段之間添加一個帶有井號（＃）的空行。
>>> # 要學習任何語言茵肃，您必須遵守以下規(guī)則腔长。
... # 1. 了解基本語法，數(shù)據(jù)類型验残，控制結(jié)構(gòu)和條件語句捞附。
... # 2. 學習錯誤處理和文件I/O。
... # 3. 了解高級數(shù)據(jù)結(jié)構(gòu)胚膊。
... # 4. 編寫函數(shù)并學習面向?qū)ο蟾拍睢?...
>>> "Let's start to learn Python."
"Let's start to learn Python."
文檔注釋
文檔注釋是為每個Python模塊故俐，函數(shù)，類和方法添加快速注釋紊婉。它必須是對象（模塊，函數(shù)辑舷，類和方法）定義中的第一個語句喻犁。
使用'''來定義文檔注釋
>>> def pow(a, n):
... '''
... 計算并返回a的n次方。
... '''
... return a ** n
...
>>> pow(2, 10)
1024
>>> print(pow.__doc__)
計算并返回a的n次方。
另外肢础，我們也可以通過pydoc3命令生成注釋文檔还栓。
$ ls -l /usr/local/bin/pydoc3
lrwxr-xr-x 1 root wheel 68 Sep 30 10:14 /usr/local/bin/pydoc3 -> ../../../Library/Frameworks/Python.framework/Versions/3.7/bin/pydoc3
------------
docstring.py文件
-------------
def pow(a, n):
'''
計算并返回a的n次方
'''
return a ** n
-------------
$ pydoc3 ./docstring.py
Help on module docstring:
NAME
docstring
FUNCTIONS
pow(a, n)
計算并返回a的n次方
FILE
/Users/xxx/Desktop/Python/docstring.py
