0

引数 (オブジェクト) とそのすべてのプロパティを文書化する適切な方法は何だろうと思っていました。

  1. 角括弧が「オプション」を意味することを正しく理解していれば、そうですか？
  2. オブジェクトのプロパティを記述するために使用した構文は有効ですか?
  3. プロパティは数値ですが、そのreqSettings.retryInterval単位を含める方法が見つかりませんでした。この数値がミリ秒であることを示す方法はありますか?

コード：

  /** 
   * used as a facade for the 'callServer' function.
   * @param {object} reqSettings           - a settings object to provide 'callServer'.
   * @param {object} reqSettings.ajaxOpt   - an object containing standard jquery ajax settings.
   * @param {function} reqSettings.success - a success handler for 'fulfilled' promises.
   * @param {function} reqSettings.failure="failResponse" - a failure handler for 'rejected' promises.
   * @param {number} [reqSettings.retries=0] - maximum retries allowed per cycle  
   * @param {number} [reqSettings.retryInterval=1500] - interval to use between retries (ms)  
   * @param {number} [reqSettings.attempted=1] - a counter used to count total attempts  
   */
  function gateKeeper(reqSettings) {
    if ( !reqSettings.retries )       { reqSettings.retries = 0 }
    if ( !reqSettings.retryInterval ) { reqSettings.retryInterval = 1500 }  
    if ( !reqSettings.attempted )     { reqSettings.attempted = 1 }

    reqSettings.retries--

    if ( !reqSettings.success || !reqSettings.ajaxOpt.url ) {
      throw new TypeError("success handler or ajax url property is missing")
    }

    return callServer(reqSettings)
  }
4

1 に答える 1

0

角括弧が「オプション」を意味することを正しく理解していれば、そうですか？

あなたは正しく理解しました。

オブジェクトのプロパティを記述するために使用した構文は有効ですか?

jsdoc はあなたの構文を理解するので、「有効」と呼びます。

プロパティは数値ですが、そのreqSettings.retryInterval単位を含める方法が見つかりませんでした。この数値がミリ秒であることを示す方法はありますか?

jsdoc には、これを記録する特別な方法はありません。「再試行の間に使用する間隔 (ミリ秒)」のように、ドキュメントに注意する必要があります。

于 2014-12-22T17:36:36.540 に答える