JavaScript の為のドキュメント作成ツール jsdoc-toolkit

JavaScript用のドキュメント作成ツール jsdoc-toolkit というものを見つけた。
jsdoc-toolkit 自身も JavaScript で記述されているのだが、Rhino を使って動作するため、実際に動かすには Java Runtime 環境が必要。

jsdoc-toolkit を動かす為のシェルスクリプトをつくってみた

jsdoc-toolkit を動かす際は下記のようなコマンドを打つ必要がある。

$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc  jsのファイル名

でも、いちいち打つのが面倒なのでシェルスクリプトを作ってみた。

#!/bin/bash

#jsdoc-toolkit が設置されているディレクトリのパス
_jsdocDir=~/bin/jsdoc-toolkit


_file=$1  # ドキュメント制作対象の js ファイル名
_out=$2  # ドキュメント出力先ディレクトリのパス

#ディレクトリの指定が無い場合はカレントディレクトリにドキュメントを作成
if [ -z "${_out}" ] ; then
        _out=./
fi


#メイン実行部
java -jar ${_jsdocDir}/jsrun.jar ${_jsdocDir}/app/run.js -a -t=${_jsdocDir}/templates/jsdoc -d=${_out} ${_file}

取り扱いは自己責任で〜