JavaScript
document

JSDocの書き方

まずはじめに

JavaScriptのドキュメント、主にオブジェクト型の返り値と引数を記述する際面倒なのでこの際全部まとめてみようと思います。


/**
 * 変数における宣言
 * @type {Number} 説明を記述する。 他にも boolean stringなどがある
 */
const exampleValue = 4;

/**
 * 配列における宣言
 * @type {Array} 配列の記述方法
 */
const exampleArray = [];

/**
 * オブジェクト型における宣言
 * @type {Object} obj - オブジェクトの説明
 * @property {String} exampleObjectValue オブジェクトの中身のプロパティ
 */
const exampleObject = { exampleObjectValue:'string' };

/**
 * 
 * @param {Object} props 引数
 * @param {?String} props.name 名前
 * @return {Object} obj 返り値
 * @return {String} obj.name - ユーザの名前
 */
const sample = props => {
  if ( props.name == undefined ) props.name = 'GUEST USER';
  return props;
}

随時更新