如何記錄一些參數在JavaScript中是可選的？

我有以下代碼。如何記錄一些參數在JavaScript中是可選的？

// optional: itemTemplate, SubitemView, SubitemModel 
     this.itemTemplate = options.itemTemplate; 
     this.SubitemView = options.SubitemView; 
     this.SubitemModel = options.collection.model;

而所有這些變量實際上是可選的。
如果提供，客戶端可以調用使用這些變量的函數。

如上所述，我只是把評論「可選：...」。
我想知道是否有更好的方法來通知其他程序員一些變量在函數中是可選的？

最好在代碼中。如在其他語言中的foo（a，b ='foo'）。

上面的代碼是在主幹視圖中，如果有所不同。

來源

2014-02-26 eugene

您可能想要查看http://usejsdoc.org/ –

如何（根據什麼工具，語法？）記錄參數？ – Bergi

有沒有辦法在代碼中自行記錄它？ – eugene

我也建議使用JSDoc：Docs

/** 
* @param {string} [somebody] - Somebody's name. 
*/

這將創建在JSDoc3語法可選PARAM。然後可以使用以下命令生成文檔：this

來源

2014-02-26 17:21:26 dejno

如何記錄一些參數在JavaScript中是可選的？

回答

相關問題