taquaki-satwo
8/26/2019 - 8:51 AM

JSDoc

/**
 * [description]
 */


/**
 * 例示のための変数です
 * @type {Number}
 */
var exampleVal = 20;
 

/**
 * 例示のための配列です
 * @type {Array}
 */
var exampleArray = [];


/**
 * 例示のための連想配列です
 * @type {Object}
 */
var exampleObject = {
  "id": 1
  "name": "exmaple text"
}

/**
 * 例示のための連想配列です
 * @type {Object}
 */
var exampleObject = {
  /**
   * プロパティ id の説明です
   * @type {Number}
   */
  "id": 1,
  /**
   * プロパティ name の説明です
   * @type {String}
   */
  "name": "exmaple text"
}


/**
 * 例示のための関数です
 * @param  {Number} param1 引数の説明
 * @param  {Number} param2 引数の説明
 * @return {Boolean}       返り値の説明
 */
function exampleFunction(param1, param2){
  if(param1 > param2)
    return false;
  else
    return true;
}


/**
 * 例示のためのクラス
 * @constructor
 */
var exampleClass = function() {
  /**
   * プロパティの説明
   * @type {Number}
   */
  this.param1 = 0;
  /**
   * プロパティの説明
   * @type {String}
   */
  this.param2 = "";
}


/**
 * 例示のクラスのメソッド例
 * @param {Number} param1 メソッドの引数の説明
 * @return {Number} メソッドの戻り値の説明
 */
exampleClass.prototype.exmapleMethod(param1) {
  return 5;
}