はじめに
自分がよく使うフォーマットを中心に備忘録としてまとめておきます。
IDEの１つであるVSCodeのツールチップとJSDoc出力後のイメージをセットで掲載しておきます。
環境
- JSDoc
- v4.0.3
- VSCode
- v1.90.0
【スカラー型】
・boolean
ソース
/**
* true or falseの２値型
*
* @type {boolean}
*/
let data_boolean = false;
－ツールチップ－
－出力イメージ－
・number
ソース
/**
* 数値型
*
* @type {number}
*/
let data_number = 0;
－ツールチップ－
－出力イメージ－
・string
ソース
/**
* 文字列型
*
* @type {string}
*/
let data_string = '';
－ツールチップ－
－出力イメージ－
【配列型】
・Array
ソース
/**
* 配列型
*
* @type {Array}
*/
let data_array = [];
－ツールチップ－
－出力イメージ－
・Array.<number>
ソース
/**
* 配列型
*
* @type {Array.<number>}
*/
let data_array_number = [];
－ツールチップ－
－出力イメージ－
・string[]
ソース
/**
* 配列型
*
* @type {string[]}
*/
let data_array_string = [];
－ツールチップ－
－出力イメージ－
【オブジェクト型】
・Object
ソース
/**
* オブジェクト型
*
* @type {Object}
*/
let data_object = {};
－ツールチップ－
－出力イメージ－
・*
ソース
/**
* オブジェクト型
*
* @type {*}
*/
let data_object_asterisk = {};
－ツールチップ－
－出力イメージ－
・any
ソース
/**
* オブジェクト型
*
* @type {any}
*/
let data_object_any = {};
－ツールチップ－
－出力イメージ－
・Object.<string, number>
ソース
/**
* オブジェクト型
*
* @type {Object.<string, number>}
*/
let data_object_detail = {};
－ツールチップ－
－出力イメージ－
・typedef
ソース
/**
* @typedef {Object} MyObject - 複合型定義
* @property {boolean} flag - 日時
* @property {number} no - ユーザー名
* @property {string} str - コメント
*/
/** @type {MyObject} */
－ツールチップ－
👇MyObjectにカーソルを合わせた時
👇data_object_typedefにカーソルを合わせた時
MyObjectにカーソルを合わせないと@typedefの内容が表示されないので注意が必要
－出力イメージ－
👇Type Definitionsの欄に出力される
👇変数名の欄に出力される
@typedefの内容は変数名の欄とは別の場所に出力されるので注意が必要
【関数型】
・無名関数
ソース
/**
* @callback MyCallback - 無名関数
* @param {boolean} flag - 日時
* @param {number} no - ユーザー名
* @param {string} str - コメント
* @returns {boolean} - true（成功） or false（失敗）
*/
/** @type {MyCallback} */
let func_noname = function(){};
－ツールチップ－
👇MyCallbackにカーソルを合わせた時
👇func_nonameにカーソルを合わせた時
MyCallbackにカーソルを合わせないと@callbackの内容が表示されないので注意が必要
－出力イメージ－
👇Type Definitionsの欄に出力される
👇変数名の欄に出力される
@callbackの内容は変数名の欄とは別の場所に出力されるので注意が必要
・関数
ソース
/**
* 関数
*
* @param {boolean} flag - 日時
* @param {number} no - ユーザー名
* @param {string} str - コメント
* @returns {boolean} - true（成功） or false（失敗）
*/
function MyFunction(){};
－ツールチップ－
－出力イメージ－
【null指定方法】
・null許容
ソース
/**
* 数値型（null許容）
*
* @type {?number}
*/
let data_number_or_null = 0;
－ツールチップ－
－出力イメージ－
・null拒否
ソース
/**
* 数値型（null拒否）
*
* @type {!number}
*/
let data_number_only = 0;
－ツールチップ－
－出力イメージ－
おわりに
種類は他にも色々ありますが今後必要に応じて追加していきます。
👇参考サイト