python - 有python的文档工具吗？

Question

就像 perldoc 用于 perl，man 用于 c。

有python的吗？

Answer 1

通常，您应该使用文档字符串：

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

然后，您可以使用pydoc或sphinx生成 HTML（或其他输出格式），或使用内置help函数在活动对象上查看它们。

内置模块的文档可在线获取（也可下载）或通过help.

Answer 2

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

$ pydoc sys

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

$ pydoc -g

Answer 3

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

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

关于模块 posixpath 的帮助：

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

文件 /usr/lib/python2.7/posixpath.py

模块文档 http://docs.python.org/library/posixpath

描述 不是直接导入这个模块，而是导入 os 并将这个模块称为 os.path。“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.

功能

... ... ..