フロントエンドTweetこんにちはエンジニアの松崎です。ある日、JavaScriptのコメントルールを調査している際に見つけた便利なツールをご紹介します!ESDocとはJS(ES6)向けのAPIドキュメントツールです。JSのドキュメントツールと言えばJavaDocのJavaScript版JSDocというツールが多く使われています、JavaDocとは、JavaのソースコードからHTML形式のAPI仕様書を生成できるツールです。トランスパイル(ソースからソースへのコンパイル)した後、ES5のコードにコメントを記述する必要があります。ESDocではES6のコードに直接書くことができるため、全ブラウザがES6に対応し移行しても書き直す必要がありません。見やすいドキュメントを自動で生成できる特徴的な機能だけでも、以下の機能が提供されています。組み込み検索この機能の詳細については次回の使用編で説明します。}}このような形でJSDocと全く同じです。※ESDocはJSDocのすべてのタグをサポートしているわけではないそうです。ESDocを導入していきます。導入に当たってnodeやnpm等の環境を整えるところから始めます。バージョン管理ツール)を導入します。-l以上を実行したら、次に今回使いたいnodeのインストールを行います。--list使用したいnodeのバージョンを見つけてください。見つかれば以下を実行します。導入したいバージョンを指定します。rehash確認を行います。今までにインストールしたnodeのバージョンを表示します。v7.7.2以上が表示さればインストール完了です。実際に使用するにはグローバルとローカルでnodeを切り替えて使用します。#今回はこちらlocalでは.node-versionというファイルが生成されます。コマンドを打ち込んだディレクトリに移動するだけでバージョンが切り替わります。プロジェクトごとに別バージョンのnode.jsを使用する場合はlocalで使用します。v7.7.2現在使用しているバージョンにアスタリスクがつきます。4.1.2確認ができればnodeとnpmのインストールは完了です。用に作られたパッケージモジュールを一括で管理できるツールです。npmで出来ることJavaScript(Node.js)のパッケージやモジュールのインストール、アップデート、共有npmレジストリに登録された様々な外部ライブラリやパッケージのインストールpackage.jsonの作成package.jsonとはパッケージの依存関係を記したJSONファイルです。package.jsonで出来ることファイルにプロジェクト毎に必要なパッケージの名前とバージョンを記述すれば、npmが勝手に必要な(依存しているという)パッケージをインストールされます。インストールしたパッケージが依存しているパッケージや、さらにそれが依存しているパッケージも自動でインストールされます。チームで開発している場合にも、Git上に上げて共通の環境の作成や復元が簡単になります。今回はpackage.jsonでパッケージを管理します。initと入力してください。これでpackage.jsonファイルが生成されます。途中対話式で設定ファイルを設定できますが設定しない場合は、基本的にすべてEnterでいいと思います。ESDocの導入ここからESDocの導入になります。先ほどインストールしたnpmでESDocをインストールします。package.jsonの置いているディレクトリで入力します。