JavaScript：YUIdocでコメントからAPIドキュメントを生成 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• JavaScript：YUIdocでコメントからAPIドキュメントを生成 へ行く。
• JavaScript：YUIdocでコメントからAPIドキュメントを生成 の差分を削除

*JavaScript：YUIdocでコメントからAPIドキュメントを生成 [#u48b3244]

YUIdocをつかって、JavaScriptのコメントからAPIドキュメントを生成します。

出力されるHTMLがすごいきれいでイケてますｗ

公式サイト
-http://yui.github.io/yuidoc/

**YUIdocのインストール [#d4bc382e]

+nodejs,npmのインストール&br;
epelを設定していれば、yumでインストール可能です。&br;
こちらを参照&br;
https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager#wiki-rhelcentosscientific-linux-6&br;
epelの設定まで含めるとこんな感じです。
 yum repolist
 rpm -Uvh http://download-i2.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm
 sudo yum install nodejs --enablerepo=epel
 sudo yum install npm --enablerepo=epel
+yuidocjsのインストール&br;
npmでインストールします。
 sudo npm -g install yuidocjs

以上でインストール完了です。

インストールが完了すると、「yuidoc」というコマンドが実行可能となります。

**YUIdocでAPIドキュメントを生成 [#p2a0afbf]

YUIdocでAPIドキュメントを生成するためには、以下の2つを作成する必要があります。

-yuidoc.json
-コメントの入ったソースコード

これだけで、YUIdocがイカしたHTMLのAPIドキュメントを生成してくれます。


***1.yuidoc.json [#qee84f0a]
こんな感じで書きます。
 {
     "name": "Test YuiDoc",
     "description": "YUIdocのテスト.",
     "version": "0.1",
     "url": "http://www.hiihah.info",
     "options": {
         "outdir": "../../docs",
         "paths":["./"],
         "exclude":"resources"
     }
 }

まあ、見たままですねw。

特に重要なパラメータとしては以下の3つがあります。
-outdir　：　html一式の出力先。これを誤ると、変なところに一式が出力されて、掃除が大変なので気をつけましょうw（当方、一回喰らいましたw）
-paths　：　APIドキュメント生成対象のコードが格納されているルートディレクトリ
-exclude　：　除外対象パターン。pathsからの相対パスにたいしてパターンマッチ可能&br;
この場合は、「resources」と言う文字列が含まれるものについては除外する設定となっています。

詳細は以下のURLを参照ください。※ページ中程にyuidoc.jsonに関する記述があります。
-http://yui.github.io/yuidoc/args/index.html


***2.コメント入りのJavaScriptコード [#r64806fe]

コメントの仕様は以下のURLに記載されています。
-http://yui.github.io/yuidoc/syntax/index.html

サンプルは以下の通りです。

 /**
 YUIdoc出力サンプルのモジュール
 
 @module sampleModule
 **/
 this.createjs = this.createjs || {};
 
 /**
 YUIdoc出力サンプルのクラス
 @class Sample
 @constructor
 @param args1 {number} サンプルの引数１
 @param args2 {String} サンプルの引数２
 **/
 function Sample(args1, args2) {
 	var a,b,sampleProperty,add;
 	a = args1;
 	b = args2;
 
 	/**
 	* サンプルのプロパティ
 	* @property sampleProperty
 	* @type number
 	* @default 0
 	**/
 	sampleProperty = 0;
 
 	/**
 	* 引数を足し算するメソッド
 	* @method add
 	* @param a {number} 足し算をする数値
 	* @param b {number} 足し算をする数値
 	* @return {number} a+bを返却
 	**/
 	add = function(a,b){
 		return a + b;
 	};
 	
 	return {
 		c:c,
 		add:add
 	};
 }

***3.yuidocコマンドで出力 [#q52d2e9e]

yuidoc.jsonをソースコードよりも上位のディレクトリに入れて、yuidoc.jsonが格納されているディレクトリでyuidocコマンドを実行すると、outdirに指定したディレクトリにAPIドキュメント一式が生成されます。

 yuidoc

**生成されたドキュメント [#h0628b9b]

こんな感じです。

-クラスの定義
#ref(yuidoc_sample1.png)

-メソッドの定義
#ref(yuidoc_sample2.png)

-プロパティの定義
#ref(yuidoc_sample3.png)