JSDoc / JSのドキュメント生成ツール

JSDoc使い方メモ

@use JSDoc

> npm install jsdoc --save

node_modules\.binに移動してからコマンドを実行する。

// バージョン確認
ode_modules\.bin>jsdoc -v
JSDoc 3.5.5 (Thu, 14 Sep 2017 02:51:54 GMT)

// フォルダやファイルを指定して実行
node_modules\.bin>jsdoc ../../compnent/GoogleSheetScreen.js

\node_modules\.bin\outというフォルダができているのでなかのindex.htmlをチェックする。

config.json

{
    "source": {
      "include": ["../../compnent/"],     //読込先
      "excludePattern": "(^|\\/)libraries\\/"　//対象外
    },
    "opts": {
      "destination": "../../jsdoc/"　//出力先
    }
  }

// configを読み込んで実行する
node_modules\.bin>jsdoc -c ../../conf.json

node_modules\.bin>jsdoc と　npm では実行するディレクトリが異なるので、config.jsonのパスを変更しておく。

config.json

{
    "source": {
      "include": ["./compnent/"],
      "excludePattern": "(^|\\/)libraries\\/"
    },
    "opts": {
      "destination": "./jsdoc/"
    }
  }

<copede>
package.jsonにscriptを追加する

package.json

{
  "main": "node_modules/expo/AppEntry.js",
  "scripts": {
    "start": "expo start",
    "android": "expo start --android",
    "ios": "expo start --ios",
    "eject": "expo eject",
    "jsdoc": "./node_modules/.bin/jsdoc -c ./conf.json"  //追加
  },
  "dependencies": {
    "expo": "^31.0.2",
    "firebase": "^5.7.0",
    ～～～

>npm run jsdoc

> @ jsdoc C:\Users\xxx
> jsdoc -c ./conf.json