javascript:jsdoc
差分
この文書の現在のバージョンと選択したバージョンの差分を表示します。
| 次のリビジョン | 前のリビジョン | ||
|
javascript:jsdoc [2019/02/09 15:39] ips 作成 |
javascript:jsdoc [2019/02/09 16:14] (現在) ips |
||
|---|---|---|---|
| ライン 4: | ライン 4: | ||
| [[https://qiita.com/opengl-8080/items/a36679f7926f4cac0a81|JSDoc使い方メモ]] | [[https://qiita.com/opengl-8080/items/a36679f7926f4cac0a81|JSDoc使い方メモ]] | ||
| + | |||
| + | [[http://usejsdoc.org/about-configuring-jsdoc.html|@use JSDoc]] | ||
| ====== インストール ====== | ====== インストール ====== | ||
| ライン 25: | ライン 27: | ||
| + | ====== 設定ファイル ====== | ||
| + | <code json config.json> | ||
| + | { | ||
| + | "source": { | ||
| + | "include": ["../../compnent/"], //読込先 | ||
| + | "excludePattern": "(^|\\/)libraries\\/" //対象外 | ||
| + | }, | ||
| + | "opts": { | ||
| + | "destination": "../../jsdoc/" //出力先 | ||
| + | } | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | <code> | ||
| + | // configを読み込んで実行する | ||
| + | node_modules\.bin>jsdoc -c ../../conf.json | ||
| + | </code> | ||
| + | |||
| + | ====== npm run jsdoc から実行できるようにする ====== | ||
| + | |||
| + | node_modules\.bin>jsdoc と npm では実行するディレクトリが異なるので、config.jsonのパスを変更しておく。 | ||
| + | |||
| + | <code json config.json> | ||
| + | { | ||
| + | "source": { | ||
| + | "include": ["./compnent/"], | ||
| + | "excludePattern": "(^|\\/)libraries\\/" | ||
| + | }, | ||
| + | "opts": { | ||
| + | "destination": "./jsdoc/" | ||
| + | } | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | package.jsonにscriptを追加する | ||
| + | <code json 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", | ||
| + | ～～～ | ||
| + | </code> | ||
| + | |||
| + | <code> | ||
| + | >npm run jsdoc | ||
| + | |||
| + | > @ jsdoc C:\Users\xxx | ||
| + | > jsdoc -c ./conf.json | ||
| + | </code> | ||
| + | |||
| + | ====== サンプル ====== | ||
| + | |||
| + | {{:javascript:pasted:20190209-161256.png}} | ||
| + | |||
| + | ↑を元に↓が生成 | ||
| + | |||
| + | {{:javascript:pasted:20190209-161310.png}} | ||
| + | ※なぜかアロー関数はドキュメントを作成しなかった。 | ||
javascript/jsdoc.1549694381.txt.gz · 最終更新: 2019/02/09 15:39 by ips
