Dash:編碼API文檔工具簡單介紹

前言

Programmer 是一直學(xué)習(xí)的一個職業(yè)充蓝,而學(xué)習(xí)最快也最深入的方式就是學(xué)習(xí)編碼原始文檔隧枫。
可是查找詳細(xì)的原始文檔是一個麻煩且低效的過程,今天在這里介紹一個神奇的工具——Dash谓苟。

Dash

Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline documentation sets for 150+ APIs (for a full list, see below). You can even generate your own docsets or request docsets to be included.

引用 Dash 官網(wǎng)的介紹官脓。
Dash 是一個 API 文檔瀏覽器和功能代碼文檔管理器??。Dash API 文檔商店擁有功能代碼文檔和超過150+的 API離線文檔(查看完整列表涝焙,請參閱下文)卑笨,你甚至可以生成自己的文檔請求文檔被某個項目采納。

Dash 首頁

Dash 首頁的左側(cè)目錄可以看到已經(jīng)下載的 API 文檔列表仑撞,右側(cè)是具體的功能按鈕赤兴,包括下載文檔、管理文檔等隧哮。
Dash API 文檔商店

Dash 文檔商店可以看到所有 API 文檔桶良,最重要的是可以看到這邊還可以前往 Maven或者 Github 進(jìn)行開源項目的 API 文檔查找和下載(截圖不全,在左側(cè)菜單欄的第二頁)沮翔,簡直是 Programmer 的倚天劍屠龍刀陨帆!
Dash 顯示 API 文檔

Dash 的 API 文檔的具體內(nèi)容的展示頁,也就是原版的最正確的 API 文檔(不帶有任何譯者的個人理解和情感)鉴竭,讀原文才能真正提升對代碼的了解捌缙!

怎么玩轉(zhuǎn) Dash

“作者搏存,你這樣說了瑰步,我還是得進(jìn) Dash 查找 API 文檔啊,只是把打開 Google 的操作改成了打開 Dash 啊璧眠,沒差八踅埂读虏?!”有些讀者可能發(fā)問道袁滥。的確盖桥,到這里為止,查找 API 文檔還是很麻煩题翻,可是我還沒說完呢揩徊,開發(fā)者社區(qū)的力量是無限大的,Dash 也開發(fā)了接口供其他 App 快速訪問嵌赠,所以塑荒,接下來介紹的幾個工具將讓你“WOW”!

Intellij IDEA

Intellij IDEA 要下載 Dash 插件姜挺,進(jìn)入 Preferences -> Plugins齿税,在搜索輸入框鍵入 Dash,點(diǎn)擊搜索線上倉庫炊豪,安裝 Dash凌箕,重啟 Intellij IDEA,開始神奇之旅吧词渤,鼠標(biāo)點(diǎn)擊需要查詢 API 文檔的元素或方法牵舱,點(diǎn)擊鍵盤快捷鍵 Cmd+Shift+D(Mac OS用戶)或者 Ctrl+Shift+D(Windows、Linux 用戶)缺虐,WOW仆葡,直接跳轉(zhuǎn)到了 Dash 中關(guān)于該查詢項的 API 文檔的詳情頁啦(因為是模糊搜索,可能出現(xiàn)了非該語言的結(jié)果志笼,沒事沿盅,左側(cè)搜索框選擇正確的文檔)。


Intellij IDEA Plugin

VS Code纫溃、Atom

VS Code 和 Atom同樣需要安裝 Dash 插件:VS Code 選擇左側(cè)主要功能菜單的最后一項擴(kuò)展工具腰涧,輸入 Dash,安裝 Dash 插件紊浩;Atom 選擇首選項-Install窖铡,輸入 Dash,安裝 Dash 插件坊谁。盡情放肆吧费彼,鼠標(biāo)點(diǎn)擊需要查詢 API 文檔的元素或方法,點(diǎn)擊鍵盤快捷鍵 Ctrl+h(查找當(dāng)前文件的 Code 語言的 API 文檔)或者 Ctrl+alt+h(查找所有 API 文檔)口芍,WOW箍铲,直接跳轉(zhuǎn)到了 Dash 中關(guān)于該查詢項的 API 文檔的詳情頁。


VS Code Plugin

Atom Plugin

其他開發(fā)工具 IDE

當(dāng)然了 Dash 既然開放了接口鬓椭,那么偉大的社區(qū)自然會適配所有主流的 IDE颠猴,各位看官可以前往Dash 官網(wǎng)查找或者在自己順手 IDE 的插件管理界面添加 Dash 插件关划,具體快捷鍵請仔細(xì)查看 Dash 插件的介紹頁。

致謝

感謝 肥朝 的工具分享博客《碼農(nóng)日常工具推薦》的介紹翘瓮,讓我認(rèn)識了 Dash贮折,并且愛上了 Dash。

寫在最后

Dash 非常優(yōu)秀资盅,但是 Dash 并不是一個免費(fèi)的工具调榄,有條件的各位希望能夠付費(fèi)支持,希望好工具不會迫于壓力停擺呵扛,而是能夠繼續(xù)造福整個社區(qū)振峻。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市择份,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌烫堤,老刑警劉巖荣赶,帶你破解...
    沈念sama閱讀 216,544評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異鸽斟,居然都是意外死亡拔创,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,430評論 3 392
  • 文/潘曉璐 我一進(jìn)店門富蓄,熙熙樓的掌柜王于貴愁眉苦臉地迎上來剩燥,“玉大人,你說我怎么就攤上這事立倍∶鸷欤” “怎么了?”我有些...
    開封第一講書人閱讀 162,764評論 0 353
  • 文/不壞的土叔 我叫張陵口注,是天一觀的道長变擒。 經(jīng)常有香客問我,道長寝志,這世上最難降的妖魔是什么娇斑? 我笑而不...
    開封第一講書人閱讀 58,193評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮材部,結(jié)果婚禮上毫缆,老公的妹妹穿的比我還像新娘。我一直安慰自己乐导,他們只是感情好苦丁,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,216評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著物臂,像睡著了一般芬骄。 火紅的嫁衣襯著肌膚如雪猾愿。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,182評論 1 299
  • 那天账阻,我揣著相機(jī)與錄音蒂秘,去河邊找鬼。 笑死淘太,一個胖子當(dāng)著我的面吹牛姻僧,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播蒲牧,決...
    沈念sama閱讀 40,063評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼撇贺,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了冰抢?” 一聲冷哼從身側(cè)響起松嘶,我...
    開封第一講書人閱讀 38,917評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎挎扰,沒想到半個月后翠订,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,329評論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡遵倦,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,543評論 2 332
  • 正文 我和宋清朗相戀三年尽超,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片梧躺。...
    茶點(diǎn)故事閱讀 39,722評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡似谁,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出掠哥,到底是詐尸還是另有隱情巩踏,我是刑警寧澤,帶...
    沈念sama閱讀 35,425評論 5 343
  • 正文 年R本政府宣布续搀,位于F島的核電站蛀缝,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏目代。R本人自食惡果不足惜屈梁,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,019評論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望榛了。 院中可真熱鬧在讶,春花似錦、人聲如沸霜大。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,671評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至曙强,卻和暖如春残拐,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背碟嘴。 一陣腳步聲響...
    開封第一講書人閱讀 32,825評論 1 269
  • 我被黑心中介騙來泰國打工溪食, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人娜扇。 一個月前我還...
    沈念sama閱讀 47,729評論 2 368
  • 正文 我出身青樓错沃,卻偏偏與公主長得像,于是被迫代替她去往敵國和親雀瓢。 傳聞我的和親對象是個殘疾皇子枢析,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,614評論 2 353

推薦閱讀更多精彩內(nèi)容