有没有python的文档工具？

Question

像perl的perldoc，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

有 - 它叫：“pydoc”。您可以从shell运行它，例如：

$ pydoc sys

将为您提供有关sys模块的帮助。它可以通过简单的gui管理将帮助导出到html（pydoc -w）或spawn服务器：

$ pydoc -g

Answer 3

在python shell中，您可以使用help内置函数（例如，这里是os.path模块的文档）：

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

  

有关模块posixpath的帮助：

     

NAME       posixpath - Posix路径名的常用操作。

     

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

     

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

     

说明       而不是直接导入此模块，导入操作系统并参考       这个模块作为os.path。 “os.path”名称是此别名       Posix系统上的模块;在其他系统上（例如Mac，Windows），       os.path以特定的方式提供相同的操作       platform，是另一个模块的别名（例如macpath，ntpath）。

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

     

功能

     

...... ...... ..