【发布时间】:2011-06-28 04:13:17
【问题描述】:
我是第一次使用 jsdoc,它似乎不喜欢我的语法,我找不到它喜欢的任何东西:
(function(){ // issue #1
/**
* Creates an instance of a Cube animation
* @class
*/
function Cube(x, y, z){
...
}
/** @lends Cube.prototype */
cubeFrame.prototype = { // Issue #2
...
}
})();
问题 #1:由于某种原因,我收到错误消息“警告:尝试将 someMethod 记录为未记录符号 Cube 的成员。”如果我把那个包装函数留在里面。如果我把它注释掉,它就可以工作。
问题 #2:我的课程有点奇怪,当我说 @lends Cube.prototype 将以下对象应用于 Cube 和不是cubeFrame。我收到与 #1 几乎相同的错误:“警告:尝试将 getVoxel 记录为未记录符号 cubeFrame 的成员。”。我不想记录cubeFrame,我希望它的原型进入Cube 文档。
我可以重新编写这两行代码并生成文档(然后是无效代码),但我不想每次进行更改时都必须重新编写代码来生成文档!
【问题讨论】:
标签: javascript documentation jsdoc