我从Java发出的Python开始。

我想知道是否存在类似于JavaDoc API的东西，可以在其中找到该类，其方法以及如何使用它的示例。

我发现从Python(命令行)使用help(Thing)非常有用

我也发现了这一点：

http://docs.python.org/2/

https://docs.python.org/2/py-modindex.html

但是，当我们已经拥有要查找的类名称时，这似乎会有所帮助。在JavaDoc API中，我具有所有类，因此，如果我需要一些东西，可以向下滚动到一个"听起来像"我需要的类。或者有时候我只是浏览所有的类以查看它们的作用，当我需要一个功能时，我的大脑就会想起我。我们在javadoc中看到了类似的东西，还记得！！

但我似乎尚未在Python中找到类似的东西，这就是为什么我发布此问题的原因。

顺便说一句，我知道我最终会读到以下内容：

https://docs.python.org/2/library/

但是，我认为不是今天。

解决方案

pydoc？

我不确定我们是否正在寻找更复杂的东西，但这确实有用。

这是Python中所有模块的列表，不确定这是否是我们真正需要的。

如果我们使用的是Windows ActiveState，则Python随附了文档，包括可搜索帮助文件中的库参考。

标准的python库已被很好地记录。尝试跳入python并导入一个名为" os"的模块并运行：

import os   
help(os)

这将读取模块中每个项目上的文档字符串并显示它。这正是pydoc也会做的。

编辑：epydoc可能正是我们在寻找什么：

我已经从Python.org下载了Python 2.5，它不包含pydoc。

Directorio de C:\Python25

9/23/2008  10:45 PM    <DIR>          .
9/23/2008  10:45 PM    <DIR>          ..
9/23/2008  10:45 PM    <DIR>          DLLs
9/23/2008  10:45 PM    <DIR>          Doc
9/23/2008  10:45 PM    <DIR>          include
9/25/2008  06:34 PM    <DIR>          Lib
9/23/2008  10:45 PM    <DIR>          libs
2/21/2008  01:05 PM            14,013 LICENSE.txt
2/21/2008  01:05 PM           119,048 NEWS.txt
2/21/2008  01:11 PM            24,064 python.exe
2/21/2008  01:12 PM            24,576 pythonw.exe
2/21/2008  01:05 PM            56,354 README.txt
9/23/2008  10:45 PM    <DIR>          tcl
9/23/2008  10:45 PM    <DIR>          Tools
2/21/2008  01:11 PM             4,608 w9xpopen.exe
          6 archivos        242,663 bytes

但是它有(我猜是替代品)pydocgui ...

C:\Python25>dir Tools\Scripts\pydocgui.pyw

10/28/2005  07:06 PM               222 pydocgui.pyw
           1 archivos            222 bytes

这将启动一个网络服务器，并显示我在寻找什么。平台随附的所有模块以及所有类。

Doc目录包含与以下内容相同的内容：

http://docs.python.org/

非常感谢我们指导我使用pydoc。

BTW I know that I would eventually
  will read this:
  
  http://docs.python.org/lib/lib.html
  
  But, well, I think it is not today.

我建议我们犯了一个错误。 lib doc具有"类，其方法以及使用方法的示例"。这就是我们要寻找的。

我一直都在使用Java和Python。深入研究库文档，我们将找到所需的所有内容。

它不会直接回答问题(因此我可能会被降级)，但是我们可能对Jython感兴趣。

Jython is an implementation of the high-level, dynamic, object-oriented language Python written in 100% Pure Java, and seamlessly integrated with the Java platform. It thus allows you to run Python on any Java platform.

由于我们来自Java，因此Jython可能会利用Python，同时仍然允许我们使用Java知识。

我们可以将环境变量PYTHONDOCS设置为指向python文档的安装位置。

在我的系统上，它在/usr/share/doc/python2.5中

因此，我们可以在shell配置文件或者其他位置定义此变量，具体取决于系统：

export PYTHONDOCS=/usr/share/doc/python2.5

现在，如果我们打开一个交互式python控制台，则可以调用帮助系统。举个例子：

>>> help(Exception)
>>> Help on class Exception in module exceptions:

>>> class Exception(BaseException)
>>>  |  Common base class for all non-exit exceptions.
>>>  |  
>>>  |  Method resolution order:
>>>  |      Exception

文档在这里：

https://docs.python.org/library/pydoc.html

也试试

pydoc -p 11111

然后在Web浏览器中输入http：// localhost：11111

编辑：当然，我们可以使用端口号代替11111的任何其他值