Python3學習筆記 | 十七、Python的語句與語法－文檔

• 2019 年 10 月 6 日
• 筆記

一、Python文檔資源

在之前章節中，介紹的一些方法等，都是不全的。對於一個類型，有多少個方法、或者參數、屬性等，需要查看文檔。下面介紹Python里幾種文檔形式。

注釋 - 文件中的文檔

dir函數 - 對象中，可用屬性列表 文檔字元串：doc - 附加在對象上的文件中的文檔 PyDoc: help函數 - 對象的交互幫助 PyDoc: HTML報表 - 瀏覽器中的模組文檔 標準手冊 - 正式的語言和庫的說明 網站資源 - 在線教程、例子等 出版的書籍 - 商業參考書籍

下面一一查看：

二、#注釋

井字型大小注釋是程式碼編寫文檔的最基本方式。Python解析時會忽略#注釋後面的內容（只要#不在文本字元串里）。

文檔字元串（doc方式可以訪問的內容）適用於大型開發里，而#注釋適用於較小功能的開發里。之後內容中會介紹到文檔字元串。

注釋例子：

#這個是測試兩個變數相加的語句  def myadd(a, b):      return a + b  #結果返回兩個變數之和。

三、dir函數

dir函數會返回可用所有屬性列表的方式。它能夠調用任何有屬性的對象。 使用方式：dir(『』), dir(1), dir([]) 上面結果等同於：dir(str), dir(int), dir(list) 之後會說明help函數。dir函數可以被認為是help函數的精簡版。

四、文檔字元串: doc

文檔字元串是，在類、函數、方法等模組里，以字元串方式存儲的文檔。當需要調用時，對相應模組調用doc參數，就可以查看。

>>> import sys  >>> print(sys.__doc__)  This module provides access to some objects used or maintained by the  interpreter and to functions that interact strongly with the interpreter.  ....

自己創建文檔字元串：

>>> def test_doc():  ... "This is test document"  ... pass  ...  >>> test_doc.__doc__  'This is test document'

五、PyDoc: help函數

在之前介紹的dir函數，可以把所有可用的參數、函數等列出來，但沒有具體介紹。想了解具體使用方法，可以使用help函數。

>>> help(test_doc)  Help on function test_doc in module __main__:  test_doc()  This is test document  >>> help(sys)  Help on built-in module sys:  NAME  sys  MODULE REFERENCE  ...

六、其他

PyDoc：HTML報表：GUI方式的時候可以使用。不多做解釋。

標準手冊集： 可以在www.python.org下載的文檔。