yuidocインストール

　Java開発中心のプロジェクトに携わることが多いのですが、一般的にはJavaDocでドキュメントを作成します。JavaScriptは置き去りになることが多く、JavaScriptも苦労して作成したプログラムなのに仲間はずれにするのは忍びないとということで、今回はJavaScriptのドキュメント生成について、チャレンジしてみました。

　JsDocとYUIDocを候補にどちらにしようか迷ったのですが、いくつかのWebサイトを歩き回った結果、YUIDocの方が良いらしいとの記述を見て、どうせ試しにやってみるだけだから．．とりあえず、YUIDocのインストールを行ってみました。（それでも技術者か！）

　最初はEclipseのプラグインとか無いかな～と偉大なるgoogle先生に聞いてみたのですが、それらしき該当ページは見当たらずあきらめました。Node.jsをベースにドキュメントページを生成するようなので、そんなものはないのかもしれませんが、コーディング中にドキュメントのイメージが参照したりしたかった、残念です。

　誰か、知っている方がいたら、通りすがりにコメントしてもらえるとありがたいです。

さあ、気を取り直して、インストール開始です。

準備

yuidocを動作させるためにNode.jsのインストールが必要です。

インストールは以下の手順を参考にしてください。

Node.jsのインストール

ダウンロード

1. http://nodejs.org/からnode.jsをダウンロードする。
   
   
   
   「DOWNLOADS」をクリックする。
   
   残念ながら私の環境は未だに32bit Windowsなので、「Windows Installer（.msi）」を選択

インストーラーの起動

　いくつかのソフトウェアをインストールしたことがある人であれば、全く引っかかることなくインストール出来ますので適当にやってもらってもOKです。

1. 「Next」をクリック
   
2. 「I accept the ...」にチェックし、「Next」をクリック
   
3. 「Next」をクリック（ちなみに私はインストール先のパスを変えています。）
4. 「Next」をクリック（少し中身に興味はありましたが、今回はパス）
   
5. 「Install」をクリック（インストールが開始されます。引き返すなら今のうちです。）
   
6. 終わっちゃいました。「Finish」をクリック
   
7. コマンドプロンプトから動作確認
   簡単なスクリプトを実行してみましょう。
   
   コマンドプロンプトを起動してください。（こんなページを読む人は起動の仕方は不要ですよね）
   
   > node
   > cosole.log('任意のメッセージ');
   
   上記コマンドでスクリプトが実行されたことがわかります。
   
   

YUIDocのインストール

　やっと目的のYUIDocのインストールです。

1. コマンドプロンプトから、YUIDocパッケージをインストール
   
   コマンドプロンプトから以下のコマンドを実行してください。
   > npm -g install yuidocjs
   
   
   と、インストールはあっさり終わりです。

ドキュメントを作成してみましょう。

どうやら、jsを格納しているファイルと同じ場所に、yuidoc.jsonを準備したほうがいいらしい。

1. yuidoc.jsonの作成
   とりあえず、jsファイルと同じ場所に、以下の内容のファイルを作成
   
   
   
   
   
   jsonファイルの詳細は英語版ですが、こちらを参照

   http://yui.github.io/yuidoc/args/index.html
2. ドキュメント作成
   コマンドラインから、JavaScriptとJsonファイルを用意したフォルダに移動して以下のおまじないをたたくだけです。
   
   > yuidoc
   
   
   まだ、YUIDoc用にコメントが整備できていないので、いっぱい警告が表示されてしまいました。（いずれ直そう）
3. ドキュメントの表示
   しかし、エラーはあるものの、正しい構文の部分もあったので、作成されました。
   
   
   

以上が、インストールからドキュメント生成までの流れです。

また、何かわかりましたらご報告します。