如何在JSDoc3中正确记录此代码

时间:2013-09-12 08:23:05

标签: javascript jsdoc

如何在JSDoc3中正确记录此代码?

var Foo,
    doFoo;

/**
 * What JSDoc string should go here ...
 */
doFoo = function () {};

/**
 * @constructor
 */
Foo = function () {};

/**
 * ... and here ..
 */
Foo.doFoo = doFoo;

/**
 * ... and here ..
 */
Foo.prototype.doBar = doFoo;

/**
 * ... and here?
 */
Foo.prototype.doBoo = doFoo;

帮助将不胜感激..

1 个答案:

答案 0 :(得分:0)

您可能正在寻找的标签是@methodhttp://usejsdoc.org/tags-method.html),这使得解析器知道可能看起来不像函数的东西实际上是一个函数。

如果您不想复制说明,也可以使用@linkhttp://usejsdoc.org/tags-link.html)指向原始函数声明的说明。