可以通過給出一個 doc string (文檔字符串) 來文檔化一個 Python 函數。
例 2.2. 定義 buildConnectionString 函數的 doc string
def buildConnectionString(params): """Build a connection string from a dictionary of parameters. Returns string."""
三重引號表示一個多行字符串。在開始與結束引號間的所有東西都被視為單個字符串的一部分，包括硬回車和其它的引號字符。您可以在任何地方使用它們，但是您可能會發現，它們經常被用于定義 doc string。
 |
|
| 三重引號也是一種定義既包含單引號又包含雙引號的字符串的簡單方法，就像 Perl 中的 qq/.../ 。 | |
在三重引號中的任何東西都是這個函數的 doc string，它們用來說明函數可以做什么。如果存在 doc string，它必須是一個函數要定義的第一個內容 (也就是說，在冒號后面的第一個內容)。在技術上不要求給出函數的 doc string，但是您應該這樣做。我相信在您上過的每一種編程課上都聽到過這一點，但是 Python 帶給您一些額外的動機：doc string 在運行時可作為函數的屬性。
|
|
| 許多 Python IDE 使用 doc string 來提供上下文敏感的文檔信息，所以當鍵入一個函數名時，它的 doc string 顯示為一個工具提示。這一點可以說非常有用，但是它的好壞取決于您書寫的 doc string 的好壞。 | |
進一步閱讀
- PEP 257 定義了 doc string 規范。
- Python Style Guide 討論了如何編寫一個好的 doc string。
- Python Tutorial 討論了在 doc string 中如何使用空白。