Atom から API や言語のドキュメントを見るパッケージ api-docs

プログラムを記述する際、その動作や仕様を確認する為にドキュメントを参照する事が良くあると思う。通常そういった情報を参照する場合、Dash のようなスタンドアロン型アプリを利用したり、Web ブラウザから公式ページ等を見る事が多いだろう。

もしエディタに Atom を利用しておりドキュメントを簡単に見る方法を探しているのであれば、 api-docs というパッケージを利用する事で Atom 内からプログラミング言語などの各種ドキュメントに手軽にアクセスする事ができる。

https://atom.io/packages/api-docs

利用方法はシンプルだ、ドキュメントを参照したい単語の上で control-d のショートカットキーを押そう。そうすると参照するドキュメントの一覧が出て来るので、閲覧したい項目を選ぶだけだ。

このような感じにサイドパネルでドキュメントを開く事が可能となる。

参照しているドキュメントは以下の DevDocs API Documentation のものでリンク先よりどの言語に対応しているのかが確認できる。

http://devdocs.io/

同じ言語/フレームワークでもバージョン毎にドキュメントが分かれているのも良い。

ブラウザを開くより素早くドキュメントにアクセスできるので効率的で良いパッケージだ。