JSDoc(gulp-jsdoc)でドキュメント生成する方法

JSDoc(gulp-jsdoc)でドキュメント生成する方法

node.jsで作成した際に、JSDocをHTMLドキュメントにしたいという要望がありました。いくつかドキュメンテーションモジュールがあるようですがここではjsdocを使用します。

npmモジュールのjsdocをインストールします。

npm i –save-dev jsdoc

view raw
gistfile1.txt
hosted with ❤ by GitHub

モジュール バージョン
jsdoc 3.6.3

対象のjsファイルが/src/index.jsとします。以下のように実行すると、デフォルトでoutフォルダ配下にドキュメントが生成されます。

npx jsdoc ./src/index.js

view raw
gistfile1.txt
hosted with ❤ by GitHub

conf.json

package.jsonと同じ場所にconf.jsonというファイルを作成します。(詳細はnpx jsdoc -h)

このJSONファイルに対象ファイルや除外ファイル、出力先などを指定しておくことで細かい設定が可能となります。

{
"source": {
"include": ["./src/"] // src配下のjsを対象とする
},
"opts": {
"destination": "./docs/" // docs配下にHTMLを生成する
}
}

view raw
gistfile1.txt
hosted with ❤ by GitHub

コンフィギュレーションファイルを指定する場合は以下のようにタイプします。

npx jsdoc -c conf.json

view raw
gistfile1.txt
hosted with ❤ by GitHub

これで、src配下の全てのjsファイルのjsdocが生成されます。src配下がさらにディレクトリ構成となっている場合は-rオプションを指定してあげる必要があります。

npx jsdoc -c conf.json -r

view raw
gistfile1.txt
hosted with ❤ by GitHub

jsdocに@access privateと書いた場合、そのメソッドのjsdocはドキュメント生成されないようです。

@returns tag requires a value

@returnタグ(@returns)の値を指定していない場合、jsdoc実行時に「@returns tag requires a value」というエラーが出ます。

スポンサーリンク
  • このエントリーをはてなブックマークに追加
  • Evernoteに保存Evernoteに保存
スポンサーリンク

コメントをどうぞ

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA