寫(code)之前先讀(API)

當一個軟體開發者,需要花蠻多時間來閱讀文檔以便了解如何使用某個 API 以及各種情況下它會表現的行為,因此學習如何有效率地查詢及閱讀了解 API 是蠻重要的能力。基本上如果某個 library 是你工作上常用到的,我會建議你從頭到尾把所有文件至少讀一遍,而不是需要用到時才去查。

Dash 好用,但是…

在 macOS 上,我過去是習慣使用 Dash 這工具來查詢 API,一是它整合了蠻多常用的 API 文檔,二來它查詢的速度還不錯,就個人使用上算是很好的投資,所以當時就在 App Store 買了正式版。然而好景不常,當 Dash 3 出來後,2.x 版本就常發生文件顯示不出來的問題,讓我有點惱火:angry:,這樣的品質再加上發生 被 App Store 下架 的事件,要我再付錢買 3.x 版本是不可能的事。

Zeal 是 Linux 或 Windows 上不錯的選擇

之前找到比較好的替代方案是 Zeal, 但是 Zeal 的 docset 是 Dash 提供的,道義上不能跟 Dash 打對台,因此官方並不提供 macOS 的版本。建議的解決方案是用 Wine 在 macOS 上執行 Windows 版本的 Zeal,我試過是可行的,搞定一些小問題後運作上還算正常。

devdocs.io 更棒

另一個更好的選擇是 devdocs.io,無須安裝直接網頁打開就可查詢。想要 desktop 版本? 沒問題! 這種網站最適合用 Electron 來包了: DevDocs Desktop。這是我目前最推薦的 API 文檔工具,跨 macOS, Linux, Windows 都可以使用且免費,太佛心了。