hack のためのネタ帳, etc,,,

JavaScript 用のソースコード用のドキュメンテーションシステム。
コメントを定型で書いておくと、リファレンスマニュアルを自動生成できる。

ライセンス

GPL

公式資料

Tips

Install
以下のコマンドとオプション(-g)でシステム global にインストールする
npm install -g jsdoc
らしいのだが、インストール先は ${APPDATA}/npm/node_modules/jsdoc/ 以下になっており、コマンドは ${APPDATA}/npm/jsdoc にインストールされたっぽい。
configuration
  • ${APPDATA}/npm/node_modules/jsdoc/conf.json.EXAMPLE
を参考に
  • ${APPDATA}/npm/node_modules/jsdoc/conf.json
を作成すればよいようだ。
とりあえず、Markdown plugin を有効にするため以下のように書いておいた。
{
    "plugins": ["plugins/markdown"]
}
専用コマンドの追加
.jsdoc_config に次のように書き加えて行くと良い。
eval {
  $FILE_ATTRS_MAP{copyright} = sub {'<b>Copyright:</b> '   . join(', ', @{$_[0]}) . '<br/>'};
  $FILE_ATTRS_MAP{license}   = sub {'<b>License:</b> '     . join(', ', @{$_[0]}) . '<br/>'};
  $FILE_ATTRS_MAP{note}      = sub {'<b>Note:</b><br/>'    . join(', ', @{$_[0]}) . '<br/>'};
  $FILE_ATTRS_MAP{remarks}   = sub {'<b>Remarks:</b><br/>' . join(', ', @{$_[0]}) . '<br/>'};
  $FILE_ATTRS_MAP{todo}      = sub {'<b>Todo:</b>'         . join(', ', @{$_[0]}) . '<br/>'};
  $METHOD_ATTRS_MAP{copyright} = $CLASS_ATTRS_MAP{copyright}  = $FILE_ATTRS_MAP{copyright};
  $METHOD_ATTRS_MAP{license}   = $CLASS_ATTRS_MAP{license}    = $FILE_ATTRS_MAP{license};
  $METHOD_ATTRS_MAP{note}      = $CLASS_ATTRS_MAP{note}       = $FILE_ATTRS_MAP{note};
  $METHOD_ATTRS_MAP{remarks}   = $CLASS_ATTRS_MAP{remarks}    = $FILE_ATTRS_MAP{remarks};
  $METHOD_ATTRS_MAP{todo}      = $CLASS_ATTRS_MAP{todo}       = $FILE_ATTRS_MAP{todo};
};

コメントをかく


「http://」を含む投稿は禁止されています。

利用規約をご確認のうえご記入下さい

Wiki内検索

フリーエリア

管理人/副管理人のみ編集できます