如何更加有效地查看(学习)Python第三方库文档(APIs)

Question

描述: 有时候需要了解Python第三方库的API接口,如果盲目地看,乱看,则会导致效率不高(浪费时间)

环境: Windows8+Python2.7

措施:

 1 看源代码-->pass,只需要了解API,不需要了解细节,看源码头脑发胀,无法窥得全貌
 2 看官网文档-->可以,但是由于第三方库文档良莠不齐,而且文档有时候有堆砌的感觉,没有层次感,逻辑感. (有时候需要反复查阅)
3 直接在shell中输入help(),然后查看--> 还可以,但是仅仅看这些有时候不足以全面了解某一个API接口(信息过少)

不知道菊苣们是如何做的?

Answer 1

1， 來readthedocs 搜索，風格比較清晰，文檔一般組織都還不錯。
2， Google 搜尋： 「API名稱」 + 其他關鍵字，往往能找到不錯的文章（部落格）、問答（stackoverflow）以及別人組織的文件等（如Python Modules Index: http://pymotw.com/2/ genindex.html）

Answer 2

沒有固定的好方法，我自己的經驗是，dir加上help,如果還不足以解決問題的話，可以看對應API的源碼。 Python的程式碼可讀性比較強，很優雅，但是前提是多寫多看。

Answer 3

好的第三方庫文檔都會很好，特別是國外的，原生的英文文檔都寫得很好，而api這種個人感覺應該從實踐中學，不知道的地方先help，在源碼，help的話，個人喜歡bpython去看