====== JSDoc ======
[[https://morizyun.github.io/javascript/node-js-npm-library-jsdoc.html|JSDoc / JSのドキュメント生成ツール]]
[[https://qiita.com/opengl-8080/items/a36679f7926f4cac0a81|JSDoc使い方メモ]]
[[http://usejsdoc.org/about-configuring-jsdoc.html|@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をチェックする。
====== 設定ファイル ======
{
"source": {
"include": ["../../compnent/"], //読込先
"excludePattern": "(^|\\/)libraries\\/" //対象外
},
"opts": {
"destination": "../../jsdoc/" //出力先
}
}
// configを読み込んで実行する
node_modules\.bin>jsdoc -c ../../conf.json
====== npm run jsdoc から実行できるようにする ======
node_modules\.bin>jsdoc と npm では実行するディレクトリが異なるので、config.jsonのパスを変更しておく。
{
"source": {
"include": ["./compnent/"],
"excludePattern": "(^|\\/)libraries\\/"
},
"opts": {
"destination": "./jsdoc/"
}
}
package.jsonにscriptを追加する
{
"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
====== サンプル ======
{{:javascript:pasted:20190209-161256.png}}
↑を元に↓が生成
{{:javascript:pasted:20190209-161310.png}}
※なぜかアロー関数はドキュメントを作成しなかった。