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

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

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

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

2009/6/9

StaticタイプのJavaScript Docの作り方

- PR -

 Javaでいうところのstaticなメソッドは、JavaScriptでも再現可能である。この項では、staticなメソッドの場合のJavaScript Docの記述方法、主にJSON形式の場合について解説する。

 サンプルで用意したクラスは、入力チェックを行うことを想定したInputCheckクラスである。サンプルメソッドには、半角数値チェック機能を作成した。

●staticなクラス
/** 
 * @fileOverview 入力チェック機能を保有するファイルです。<br>
 * 
 * @author 遠藤 太志郎
 * @version 1.0.0
 */
 
/**
 * 
 * @class 入力チェッククラス<br>
 * 画面の入力チェックを行うための機能を集めたクラスです。<br>
 * 全メソッドがstaticになっています。
 * 
 */
var InputCheck = {
    /**
     * 半角数字チェック<br>
     * <br>
     * 照合対象文字列が全て半角数字であるかどうかをチェックする。
     * 
     * @param {String} 	str 照合対象文字列
     * @return {boolean}    true:全て半角数字の場合
     *                      false:半角数字以外が含まれる場合
     * @example 
     * var str = "エラーワード";
     * if(InputCheck.isNumeric(str)){
     * 	alert("半角数字を入力してください。");
     * 	return false;
     * }else{
     * 	return true;
     * }
     */
    isNumeric: function(str) {
        if(str.match(/[^0-9]/g)){
            return false;
        }else{
            return true;
        }
    }
}

 出力結果は、画面8のようになる。このように、JSONタグで書かれたstaticなメソッドには、自動的にstaticの文字が表示されるようになる。

画面8 Input Checkクラス
Input Checkクラス

組み込みクラスのJavaScript Docの作り方

 Javaがクラスベースのオブジェクト指向言語である一方で、JavaScriptはプロトタイプベースのオブジェクト指向言語である。そのため、JavaScript自体に組み込まれているDate型やString型のプロトタイプに追記することで、String型そのものに新しい機能を持たせることも可能である。

●String型の拡張
/** 
 * @fileOverview JavaScript組み込みクラスであるString型を拡張するJSファイルです。<br>
 * 
 * @author 遠藤 太志郎
 * @version 1.0.0
 */
 
/**
 * 空白を取り除く。<br>
 * <br>
 * 文字列の左右から空白スペースを取り除きます。
 *
 * @param {String} str 対象文字列
 * @return {String} 空白スペースを取り除いた文字列
 * 
 * @example 引数の文字列から空白スペースを取り除く。
 * var str = "     ABCDE     "
 * str.trim();
 * 
 */
String.prototype.trim = function() {
    return this.replace(/^[ ]+|[ ]+$/g, '');
}

 この場合、クラス名の表記も独自開発のクラスとは違って組み込みクラスとして表示される。

画面9 組み込みクラス
組み込みクラス

グローバルタイプのJavaScript Docの作り方

 最後に、クラスではなく単純にfunctionを書き連ねた場合の表記方法を説明する。

●グローバルメソッド
/** 
 * @fileOverview クラス化されていない、グローバルのfunction機能を保有するファイルです。
 * 
 * @author 遠藤 太志郎
 * @version 1.0.0
 */
 
/**
 * 名前の表示
*
* 名前をアラートで表示する。 * * @return {void} * @param {String} name 名前 * @param {String} familyName 苗字 * * @example * viewName("遠藤","太志郎") */ function viewName(name,familyName){ alert("私の名前は" + name + familyName + "です。"); } /** * @augments viewName * @return {void} * @param {String} name 名前 * @param {String} familyName 苗字 */ function test(name,familyName){ alert("私の名前は" + name + familyName + "です。"); }

 これを出力すると、すべてグローバルのページに表示される。

画面10 グローバル
AnimalクラスのJavaScript Doc

 これまで、本稿ではオブジェクト指向言語としてのクラス管理という観点から論述してきたが、開発現場では結局はこのような形で書いて済ませてしまうことが最も多いのではないだろうか。

 実際のところ、それで乗り切れてしまうことも多いわけだが、JsDoc Toolkitを利用してJavaScriptをライブラリ化し、効率的な開発を行うためにも、ぜひともJavaScriptにクラスという概念を導入して開発を行って欲しい。

JavaScript docタグ

 以上のように、JavaScript Docは@タグ+説明文章で作られる。本稿で実例を紹介したのは以下のタグである。

●本稿で紹介したタグ一覧
@fileOverview JSファイルの説明
@author 作成者
@version バージョン
@class 関数がクラスであることを示す
@param 引数
@return 返り値
@example 関数の使用例

 JsDoc Toolkitには、これら以外にも継承を意味する@augumentsや、参照を意味する@seeなど、ほかにもいくつか使用可能なタグが存在する。紹介していないタグを使用したい場合は、公式サイトの一覧表を参照して欲しい。

 後編では、JsDoc Toolkitに少し手を入れて使いやすい環境を構築する方法について解説する。

prev
3/3
 

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