JsDoc Toolkitによる開発効率向上を目指して

JavaScript開発を見直そう(後編)

JsDoc Toolkitを使いやすくカスタマイズする

遠藤 太志郎
株式会社インテック
ネットワーク&アウトソーシング事業本部

2009/6/18

テンプレートの変更

 最後に、出力するHTMLのデザインを決定するテンプレートについて説明する。

 本稿に従ってJsdoc-toolkitを実行した方はすでにお気付きになったかもしれないが、出力されたJavaScript Docは前編で紹介した画面とは異なっているはずである。

 その理由は、前編で紹介した画面のテンプレートが、ダウンロードしたライブラリに梱包されているテンプレートjsdocではなく、私が一部を日本語に翻訳した改造テンプレートjsdocJpを使用しているからである。

●jsdoc
●jsdocJp

 テンプレートは.tmplという拡張子のファイルを読み込んで作られており、これを書き換えることによって、自分好みの表示やデザインに変更できる。

 テンプレートはWeb上にいくつか公開されている。公式サイトのテンプレートギャラリーの中からoutlineテンプレートを紹介しよう。

 outlineテンプレートを使って、本稿のサンプルスクリプトからJavaScript Docsを出力すると以下のようになる。

●outlineテンプレート

 標準のjsdocテンプレートと比べると、かなり鮮やかな雰囲気になることが分かるだろう。

 テンプレートのカスタマイズには労力が必要だが、独自に作成したJavaScriptを外部に公開するような場合ならば、テンプレートの見直しについて考えてみる価値もあるだろう。

JavaScriptによる開発の未来のために

 JavaScript Doc作成ツールに関する説明は以上である。多くのシステムエンジニアの方がこれを用いることによって、より良いWebシステムを開発していただければ幸いである。

 JavaScriptによる開発は、C言語やJavaなど従来のサーバ環境のプログラミングに比べて、蓄積されたノウハウが少ない。そのため、開発工数の見積もりや、WebブラウザによるJavaScriptの挙動の違い、レスポンス速度など、開発フェイズを問わず色々な場面で問題を抱えている開発現場も少なくないだろう。

 しかし、そうした問題も、みんながそれぞれの知識を@ITに寄稿するなどして情報共有を深めていくことができれば、日本中でより素晴らしいWebシステムを開発できるようになる未来も、きっとそれほど遠い話ではない。

 そのような希望を抱きつつ、私の今回の論稿を終了とする。

prev
3/3
 

Index
JsDoc Toolkitを使いやすくカスタマイズする
  Page1
自分好みのJsDoc Toolkitを構築する
JsDoc Toolkitセットアップ
実行サポートファイルの作成
  Page2
コンストラクタの設定
オプションの設定
ファイルパス指定
JavaScript Docの出力実行
Page3
テンプレートの変更
JavaScriptによる開発の未来のために

index Coding Edgeフォーラム トップページ


Coding Edge フォーラム 新着記事
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)

注目のテーマ

>

Coding Edge 記事ランキング

本日 月間