JavaScript 用のソースコード用のドキュメンテーションシステム。
コメントを定型で書いておくと、リファレンスマニュアルを自動生成できる。
とりあえず、Markdown plugin を有効にするため以下のように書いておいた。
コメントを定型で書いておくと、リファレンスマニュアルを自動生成できる。
以下のコマンドとオプション(-g)でシステム global にインストールする
npm install -g jsdocらしいのだが、インストール先は ${APPDATA}/npm/node_modules/jsdoc/ 以下になっており、コマンドは ${APPDATA}/npm/jsdoc にインストールされたっぽい。
- ${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}; };
タグ
コメントをかく