JsDocとYUIDocを候補にどちらにしようか迷ったのですが、いくつかのWebサイトを歩き回った結果、YUIDocの方が良いらしいとの記述を見て、どうせ試しにやってみるだけだから..とりあえず、YUIDocのインストールを行ってみました。(それでも技術者か!)
最初はEclipseのプラグインとか無いかな~と偉大なるgoogle先生に聞いてみたのですが、それらしき該当ページは見当たらずあきらめました。Node.jsをベースにドキュメントページを生成するようなので、そんなものはないのかもしれませんが、コーディング中にドキュメントのイメージが参照したりしたかった、残念です。
誰か、知っている方がいたら、通りすがりにコメントしてもらえるとありがたいです。
さあ、気を取り直して、インストール開始です。
準備
yuidocを動作させるためにNode.jsのインストールが必要です。
インストールは以下の手順を参考にしてください。
Node.jsのインストール
ダウンロード
- http://nodejs.org/からnode.jsをダウンロードする。
「DOWNLOADS」をクリックする。
残念ながら私の環境は未だに32bit Windowsなので、「Windows Installer(.msi)」を選択
インストーラーの起動
いくつかのソフトウェアをインストールしたことがある人であれば、全く引っかかることなくインストール出来ますので適当にやってもらってもOKです。
- 「Next」をクリック
- 「I accept the ...」にチェックし、「Next」をクリック
- 「Next」をクリック(ちなみに私はインストール先のパスを変えています。)
- 「Next」をクリック(少し中身に興味はありましたが、今回はパス)
- 「Install」をクリック(インストールが開始されます。引き返すなら今のうちです。)
- 終わっちゃいました。「Finish」をクリック
- コマンドプロンプトから動作確認
簡単なスクリプトを実行してみましょう。
コマンドプロンプトを起動してください。(こんなページを読む人は起動の仕方は不要ですよね)
> node
> cosole.log('任意のメッセージ');
上記コマンドでスクリプトが実行されたことがわかります。
YUIDocのインストール
やっと目的のYUIDocのインストールです。