~Tweetこんにちはエンジニアの松崎です。前回導入までを行なったESDocの続きです。今回は主にESDocの特徴的な機能である以下について紹介していきます。組み込み検索ホスティングマニュアルの統合ESDocではJavaScriptの開発に使用する、ドキュメントを一括で管理することができます。使い方まずはMarkdownファイルを作成します。rootディレクトリ配下にmanualフォルダを作成します。今回はusage.mdファイルを作成します。今回追記した部分になります。設定項目の詳細は以下になります。言うキーの中に設定項目を記入します。目次(マニュアルの項目)をESDocのHomeに表示するかの設定です。指定した場合、HomeディレクトリのREADMEは表示されません。使用方法のマニュアルを使用する設定です。そのほかOverviewDesignInstallationUsageTutorialConfigurationExampleAdvancedFAQChangelogこれだけのマニュアルを作成・分類することができます。カバレッジコメントが書かれるべきところ(クラス等)にどれだけ書かれているのか確認する機能です。このように自動的にファイルごとにカバレッジを出力してくれます。Lintソースコードに対して書いたコメントの引数名と実際の引数名に違いがあった場合esdocコマンド実行時にエラーとして出力されます。src/~~~~静的解析コメントなどが一切書かれていないソースコードでも、ソースコードからわかる情報で最低限のドキュメントを作成してくれます。「継承されているClass」や「return文の戻り値の存在」などです。テストコードの統合JSで使用しているテストコードもESDocで管理することができます。※今の所対応がmochaのみとなっているみたいです。.esdoc.jsonファイルに追記して設定します。}}testの部分が今回追記した設定になります。言うキーの中に設定項目を記入します。テストコードを配置しているディレクトリを指定します。以上で設定は完了しました。後は、テスト対象のコードにコメントを追記します。続けてクラス名やメソッド名を記入することで関連付けすることができます。ソースコードのクラス名、メソッド名と一致させてください!ソースコードにテストコードへのリンクが貼られました。これでソースコードのドキュメントからテストコードへのドキュメントへの移動が簡単にできるようになりました!組み込み検索ESDoc内で管理されているClassやメソッドを検索することができます。悩み...今回、悩んだところはマニュアルを分割させるところです。ESDocではMarkdownファイルはHTMLファイルに変換されるためリンク先はhtmlファイルにしなければいけませんでした。Overview[使い方](./usage/usage.html)さらに開いたリンクを項目の位置までジャンプさせたかったので以下のようにMarkdownにHTMLを埋め込みました。</h3>ただマニュアルの管理方法は人それぞれなので自分のやりやすい方法にしてください!最後に今はESDocを使用検討中なのですが、サンプルを作成した際、見た目も含めかなり見やすく検索機能のおかげで目的のファイルまでの移動がかなり楽だと感じました。es6のclass構文だけのサポートになっているのでJavaScriptのfunctionベースのコードやprototypeベースのコードで使用できない点など、ESDocは全てのプロジェクトですることは導入が難しいと感じました。~こんにちはエンジニアの松崎です。16新卒のよう太です。最近、某タラ...2017-03-21EditorConfigでコーディングルールの統一こんにちはエンジニアの松崎です。Pipelinesでとりあえずユニットテストを動かす元ネタはこちらです。»ネオキャリアTECHブログこのブログは、ネオキャリアグループの技術者によるTECHブログです。ネオキャリアグループでは、転職サイトからVRまで、色々なプロダクトを開発しています。~月別アーカイブ検索スターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。