1

JSDOCの関数引数で可能な構成プロパティを文書化するにはどうすればよいですか:

/**
 * N level expectimax AI.
 *
 * @param {object} cfg  config
 *   cfg.minimaxDepth  - limit for minimax search
 *   cfg.expectiDepth  - limit for expectimax search
 *   cfg.weightFn  - position weight function
 *
 * @constructor
 */
function expectimaxAI(brdEngine, cfg) { ... }

cfg.minimaxDepth( cfg.*) パラメータに使用するマークアップはどれですか?

合成aiCfg型を文書化し、それを次のように参照することは可能ですか:

 * @param {aiCfg} cfg  config

またはどういうわけか？

4

1 に答える 1

1

公式の JSDoc 2.x ドキュメントを読んだ後、いくつかのハックを行います。

/**
 * @name BlindWeightRandomCfg
 * @function
 * @param {number} left   weight
 * @param {number} right  weight
 * @param {number} up     weight
 * @param {number} down   weight
 */

存在しない関数を次のように参照します。

/**
 * Blind weight random AI.
 *
 * @param {Board} brdEngine  board engine from board.js
 * @param {BlindWeightRandomCfg} cfg  configuration settings
 * @constructor
 */
 ai.BlindWeightRandom = function(brdEngine, cfg) { ... }

引数- クリックして!cfgの定義を表示できるようになりましたBlindWeightRandomCfg

更新JSDoc 2.x の別の可能性:

/**
 * @name BlindWeightRandomCfg
 * @namespace
 * @property {number} left   weight
 * @property {number} right  weight
 * @property {number} up     weight
 * @property {number} down   weight
 */

JSDoc 3.x の場合:

/**
  @typedef PropertiesHash
  @type {object}
  @property {string} id - an ID.
  @property {string} name - your name.
  @property {number} age - your age.
 */

/** @type {PropertiesHash} */
var props;

それ@typedefが解決策のようです。他のバリアントと公式ドキュメントを参照してください。

于 2014-09-14T22:48:40.597 に答える