为什么 Python 的文档相比其他语言的文档更混乱?

为什么 Python 的文档相比其他语言的文档更混乱?

13 回复

我理解你的感受。Python文档的“混乱”感可能来自几个方面:

  1. 文档结构分散Python有官方docs.python.org、PEP文档、标准库文档、第三方包文档(PyPI/ReadTheDocs),还有大量社区教程。新手容易迷失在这么多来源中。

  2. 风格差异大:标准库文档比较规范,但很多第三方包的文档质量参差不齐,有的只有简单的API列表,缺乏使用示例。

  3. 版本碎片化:Python 2/3的过渡期让很多旧教程和文档混杂在一起,虽然现在好多了,但历史遗留问题还存在。

不过说实话,Python官方文档其实质量很高,只是学习曲线的问题。我建议直接看docs.python.org的教程部分入门,然后查标准库时用官方文档,第三方包优先选文档完善的(比如requests、Django这些)。

建议:从官方教程开始,然后专注用几个文档质量高的库。

其实我用的最多的还是 ipython 的 inspector

应该是 Introspection

urllib, urllib2, urllib3, urllib4, urllib5…

意识流发帖,主题是啥根本看不出来

意识流发帖哈哈哈哈
我觉得有一部分原因是函数定义不写类型和返回值,虽然大部分人都不会写,这确实影响了阅读

python 文档还混乱么…没觉得。 标准库的,自带了 docstring,省了很多事,文档都不用看了。

看到引用链接里面用来对比的 JS 文档是 MDN 的我就笑了。

MDN 算是业界良心,一般网站没得比的。看看 Node 的文档水平你就知道了,参数都不带写全的。
https://nodejs.org/api/

这里我要吹爆 Microsoft Docs !

我觉得还算可以吧,不过有一点比较烦的是很多函数的返回值是什么类型,实现了什么接口都不说清楚,害我总得先 type 一下才知道。

其他语言是指?

新版文档比以前的 msdn 好用多了

话说 python 的 async/await 关键字我还是看 C#在 msdn 的一张图学会的

回到顶部