JavaScript (22) JsDoc Toolkit でドキュメント作成

プレイアウトのロジックを作る前に、プログラム全体を見渡すためにドキュメントを整備することにしました。
Java に Javadoc というドキュメントを作るツールがあって「作って遊ぼうJavaアプレット」の連載でも使っていたのですが、JavaScript にも同様のツールがありましたので、使ってみました。JsDoc Toolkit というツールです。簡単な使い方を示します。

1. 事前に Java がインストールされている必要があります。
2. JsDoc Toolkit のサイトからツールをダウンロードし、解凍します。
3. JsDoc Toolkit のディレクトリで以下のコマンドを実行します。(Macの場合)
   java -jar jsrun.jar app/run.js src -t=templates/jsdoc -d=out

src にはソースディレクトリ、out にはドキュメントの出力先を指定します。

【図20 JsDoc Toolkit で作成したドキュメント】
今回プログラムはこの JsDoc Toolkit に対応してコメントに、@fileOverview, @name, @constructor, @this の4つのタグを追加しました。また、前回の版では活路と石の数を別々に表示していましたが、それらの和を得点として表示するようにしました。プログラムは simulator03 として公開しました。作成したドキュメントは下の方にリンクが張ってあります。

【図21 Simulator 0.3】
活路＋石を得点として表示してみると、最終局面で石埋めをしても得点が変わらないことに気づきます。上図の局面ではこの先を打っても得点は変わりません。このような終局で、この得点は中国ルールの得点（地＋石）と等しくなります。