Python语言API

6 投票
9 回答
533 浏览
提问于 2025-04-11 09:24

我刚开始学习Python,之前是用Java的。

我在想,Python有没有类似JavaDoc的东西,可以让我找到类、它的方法,还有使用示例。

我发现用Python命令行里的help( thing )功能很有帮助。

我还找到了这些链接:

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

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

不过,这些似乎只有在你已经知道想找的类名时才有用。在JavaDoc里,我可以看到所有的类,如果我需要什么,就可以往下翻,找到一个“听起来像”我需要的类。有时候我也会浏览所有的类,看看它们的功能,当我需要某个特性时,我的脑海里会想起:我们在javadoc里见过类似的东西,记得吗!?

但我在Python里似乎找不到类似的东西(至少现在找不到),所以我才发这个问题。

顺便说一下,我知道我最终会去看这个:

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

不过,我觉得今天还不是时候。

9 个回答

1

顺便说一下,我知道我最终会去看这个:

http://docs.python.org/lib/lib.html

不过,我觉得今天还不是时候。

我觉得你可能犯了个错误。这个库的文档里有“类、它的方法以及如何使用它的例子”。这正是你需要的。

我一直在用Java和Python。深入看看这个库的文档,你会找到你想要的一切。

2

标准的Python库文档写得很清楚。你可以打开Python,导入一个模块,比如说“os”,然后运行:

import os   
help(os)

这段代码会读取模块中每个项目的文档字符串,并把它们显示出来。这正是pydoc所做的事情。

补充一下:epydoc 可能正是你需要的工具:

5

pydoc是什么?

我不太确定你是不是在找更复杂的东西,但这个工具可以满足你的需求。

撰写回答