猫型iPS細胞研究所

この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。

====== 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]]

====== インストール ======
<code>
> npm install jsdoc --save
</code>

====== 使い方 ======
<html>node_modules\.bin</html>に移動してからコマンドを実行する。

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

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

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


====== 設定ファイル ======
<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}}

※なぜかアロー関数はドキュメントを作成しなかった。

猫型iPS細胞研究所

ユーザ用ツール

サイト用ツール

ページ用ツール