JSDocしたい(jsdoc
)
$ jsdoc ./パス/**/*.js
$ jsdoc -c 設定.json -d ./出力先 ./パス/**/*.js
jsdoc
でJavaScriptのdocstringからドキュメントを作成できます。
インストールしたい(jsdoc
)
$ brew install jsdoc3
$ jsdoc --version
JSDoc 4.0.4 (Sat, 19 Oct 2024 19:05:34 GMT)
設定ファイルしたい(conf.json
)
{
"source": {
"include": ["パス1", "パス2"],
"includePattern": ".+\\.js$"
},
"opts": {
"destination": "./docs/jsdoc",
"recurse": true,
"template": "templates/default"
}
}
conf.json
でJSDocのオプションを設定できます。
ドキュメントしたい
1/**
2 * 関数の説明
3 *
4 * @param {型} 引数名 - 説明
5 * @return {型} 返り値 - 説明
6 * /
7function 関数名(引数) { ... }
string
: 文字列number
: 数値boolean
: 真偽値undefined
: 未定義null
: ヌル型symbol
: シンボル型Object
: オブジェクト型Array.<型>
: 配列オブジェクト型Function
: 関数オブジェクト型Date
: 日付オブジェクト型any
: 任意の型型1|型2
: ユニオン型