用於記錄作爲對象的函數參數的字段的語法

Question

我想知道什麼是文檔參數（這是一個對象） 及其所有屬性的正確方法。

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) 
    } 

Answer 1

如果我理解正確的方括號表示 「可選」，是這樣嗎？

你理解正確。

是我用來描述對象屬性有效的語法嗎？

jsdoc理解您的語法，所以我將其稱爲「有效」。

reqSettings.retryInterval屬性是一個數字，但我無法找到一種方法來包含它的單位。有沒有辦法表明這個數字是以毫秒爲單位的？

jsdoc has no special注意這一點。你必須像你所做的那樣在你的文檔中記下它：「在重試之間使用的間隔（ms）」