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

Last-modified: 2014-03-09 (日) 17:35:22 (3847d)

Top / JavaScript：YUIdocでコメントからAPIドキュメントを生成

JavaScript?：YUIdocでコメントからAPIドキュメントを生成 †

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

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

公式サイト

http://yui.github.io/yuidoc/

↑

YUIdocのインストール †

nodejs,npmのインストール
epelを設定していれば、yumでインストール可能です。
こちらを参照
https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager#wiki-rhelcentosscientific-linux-6
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のインストール
npmでインストールします。
```
sudo npm -g install yuidocjs
```

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

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

↑

YUIdocでAPIドキュメントを生成 †

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

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

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

↑

1.yuidoc.json †

こんな感じで書きます。

{
    "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からの相対パスにたいしてパターンマッチ可能
この場合は、「resources」と言う文字列が含まれるものについては除外する設定となっています。

詳細は以下のURLを参照ください。※ページ中程にyuidoc.jsonに関する記述があります。

http://yui.github.io/yuidoc/args/index.html

↑

2.コメント入りのJavaScript?コード †

コメントの仕様は以下の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
	};
}

↑