是否有Python的文檔工具？

Question

像perldoc for perl，man for c。

python有沒有一個？

Answer 1

通常情況下，你應該使用documentation strings：

def foo(bar): 
    """ Applies the foo operation onto bar """ 
    # ... 

可以再用pydoc或sphinx生成HTML（或其他輸出格式），或者使用內置的help函數來查看他們的活動對象。

內置模塊的文檔是available online（also downloadable）或通過help。

Answer 2

在Python外殼，您可以使用help內置函數（例如，這裏的os.path中模塊的文檔）：

>>> import os 
>>> help(os.path) 

幫助的模塊posixpath：

名稱 posixpath - Posix路徑名上的常用操作。

FILE /usr/lib/python2.7/posixpath.py

MODULE DOCS http://docs.python.org/library/posixpath

說明 代替直接導入此模塊，導入口，並且是指該 模塊作爲OS。路徑。 「os.path」名稱是Posix系統上 模塊的別名;在其他系統（例如Mac，Windows）上，os.path以特定於該平臺的方式提供相同的操作，並且是另一個模塊（例如，macpath，ntpath）的別名。

Some of this can actually be useful on non-Posix systems too, e.g. 
for manipulation of the pathname component of URLs. 

功能

...... ..

Answer 3

有 - 其稱爲： 「是pydoc」。你可以從shell運行它，例如：

$ pydoc sys 

會給你關於sys模塊的幫助。它可以導出幫助HTML（是pydoc -w）或產卵服務器簡單的GUI管理：

$ pydoc -g