JsDoc命名空间

Jo *_*ina 5 javascript documentation jsdoc

我正在使用 JsDoc 编辑 js 文件以获得干净的文档。我的结构非常简单:

/**
 * Finds an object
 * @param {string} prop - Property
*/

Array.prototype.findObject = function _findObj(prop, val){
    // blablabla
}


function myfunc(plep){
    // does something
}

/**
 * Workshop Namespace
 * @namespace
*/

var Workshop = {};


/**
 * Does something great
 * @param {*} plep - My super param!
*/
Workshop.doIt = myfunc;

/**
 * It works!
 * @param {string} fly - my flying param
*/
Workshop.flyNow = function _flyN (fly){
    // fly!
}
Run Code Online (Sandbox Code Playgroud)

然而,

  1. 不显示第一个功能的文档。
  2. 创建了 Workshop 命名空间
  3. Workshop.doIt 仅通过其描述进行记录,参数不记录
  4. Workshop.flyNow 有详细记录

有谁知道为什么?

谢谢!

SGD*_*SGD 1

是否Array作为符号存在?如果没有,那就是没有记录的原因。

关于参数,你确定*是一个有效的类型吗?你能试一下Object吗 ?