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

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

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

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

2009/6/9

JavaScriptを使った開発で、ソースの保守性や再利用性までを視野に入れたドキュメントを残しているだろうか。Ajaxを使った高機能なWebサービスなど、JavaScriptによる開発規模は拡大している(編集部)

Ajaxの登場と開発者の苦難

- PR -

 システムエンジニアならば、JavaScriptという言葉は誰でも聞いたことがあるだろう。Webブラウザ上で動作し、主にWebブラウザのユーザーインターフェイスの向上を目的に使用されるプロトタイプベースのオブジェクト指向型スクリプト言語だ。

 JavaScriptは、世に出てからしばらくの間は特にそれほど脚光を浴びるような技術ではなかったのだが、2005年にGoogleがGoogle Mapsを公開したころより、Ajaxという言葉と共にその有用性が改めて見直されるようになった。

 Ajaxとは「Asynchronous JavaScript And Xml」の略称で、平たくいえばJavaScriptをフル活用することで、快適なユーザーインターフェイスを実現しようとするものだ。

 今日ではAjaxを利用したWebシステムに出会うことも多くなり、おかげでユーザーは従来よりも、よりグラフィカルで、より快適なWebシステムを利用できるようになり、Webシステムの活躍はより一層大きくなりつつある。

 このように、Ajaxはユーザーにとっては良いことばかりである。だが、そのAjaxを使ったアプリケーションを開発するシステムエンジニアにとってはどうだろうか。

JavaScriptによる開発効率を上げられるか

 繰り返しとなるが、JavaScriptが世に出てからしばらくの間は、その有効性があまり知れ渡っていなかった。そのため、Webシステム全体の開発規模の中において、JavaScriptの開発が占める割合は非常に小さく、ソースの保守性や再利用性などを詰めて考えることもなしに、個人の知識や手作りのドキュメントなど、その場限りの処置で開発を乗り切れてしまった。と、このように改めていわれてみれば、確かにそのような心当たりがある、という方もいるのではないだろうか。

 現在のようなWeb 2.0時代になり、Ajaxによる高機能なWebシステムを要求されるようになるにつれ、徐々にJavaScriptの開発負荷が大きくなり、このまま従来と同様の開発手法を続ければ、いずれ必ず開発に行き詰まってしまうだろう。

 では、どのようにすればJavaScriptを使ったアプリケーション開発を効率的に行えるだろうか。その答えは複数存在するが、その1つにJavaScript機能のライブラリ化およびソースの再利用性向上が考えられる。

 そして、それを実現させるための手段として紹介するのが、JavaScript Doc自動作成ツールJsDoc Toolkitである。次項からはJsDoc Toolkitの機能および使い方についての説明を行う。

JsDoc Toolkitとは何か

 サン・マイクロシステムズが開発したオブジェクト指向言語であるJavaには、そのソースコードをAPI仕様書に変換する開発支援ツールJava docがある。Javaのソースコード中に、Java docタグを使用し、決められた形式で文章を記述しておくことで、開発したJavaクラスの説明が書かれたHTMLドキュメントを自動出力するというものだ。

 JsDoc Toolkitは上記と同じことをJavaではなくJavaScriptで行う。JavaScriptのAPI仕様書自動出力ツールJavaScript doc、それがJsDoc Toolkitである。なお、以降では便宜上、JsDoc Toolkitで出力されたJavaScriptのAPI仕様書のことを、JavaScript docと表記する。

 JavaScriptはプロトタイプベースのオブジェクト指向言語であるため、Javaと同じようにクラスを保有できる。本稿では、JavaScriptの持つクラスを以下の4つのタイプに分類する。

  1. 一般的なクラス
  2. staticなクラス
  3. 組み込み関数(Stringなど)の拡張クラス
  4. グローバルクラス(単なるfunctionの羅列)

 このようなタイプのクラスごとにJavaScript Doc出力のためのソースの書き方を出力結果と共に解説しよう。

 
1/3
next

Index
JsDoc Toolkitによる開発効率向上を目指して
Page1
Ajaxの登場と開発者の苦難
JavaScriptによる開発効率を上げられるか
JsDoc Toolkitとは何か
  Page2
一般的なクラスのJavaScript Docの作り方
  Page3
StaticタイプのJavaScript Docの作り方
組み込みクラスのJavaScript Docの作り方
グローバルタイプのJavaScript Docの作り方
JavaScript docタグ

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

@IT Special

- PR -

TechTargetジャパン


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

イベントカレンダー

PickUpイベント

- PR -

アクセスランキング

もっと見る

ホワイトペーパーTechTargetジャパン

注目のテーマ

Coding Edge 記事ランキング

本日 月間
ソリューションFLASH