如何写注释来说明一个Object对象应该包含的属性
leizongmin opened this issue · 1 comments
leizongmin commented
注释文本:
/**
* 创建日志记录器
*
* @param {String} name 日志记录器名称
* @param {Object} options
* - {String} path 日志主目录,默认为./log
* - {Number} interval 保存周期,默认为2000ms
* - {String} level 等级,fatal > error > warn > info > debug,默认为debug
* - {Boolean} output 是否在控制台输出,默认为true
* @api public
*/
输出的页面显示如下:
这样很明显是影响阅读的。建议对于未知的注释类型,可以把它隐藏起来(起码比显示undefined强),或者有神马好的注释写法来说明上面的options参数?
JacksonTian commented
/**
* 创建日志记录器
* Options:
* - `path` 日志主目录,默认为`./log`
* - `interval` 保存周期,默认为`2000ms`
* - `level` 等级,fatal > error > warn > info > debug,默认为`debug`
* - `output` 是否在控制台输出,默认为`true`
* @param {String} name 日志记录器名称
* @param {Object} options
* @api public
*/
这样写。