Question

鉴于以下情况，当我运行jsdoc时，输出不会显示foo.bar属性的任何内容。

/**
 * Foo
 */
const foo = function foo() {
  //...
}

/**
 * Bar
 */
foo.bar = function bar() {
  //...
}

如何在bar上显示foo作为属性？

Answer 1

实现这一目标有很多可能性。以下只是其中几个...

使用@memberof标签标识属于父符号的成员符号。

/**
 * Foo
 */
const foo = function foo() {
   //...
}

/**
 * Bar
 * @memberof Foo
 */
foo.bar = function bar() {
   //...
}

使用@prop标记可以轻松记录类，命名空间或其他对象的静态属性列表。

/**
 * Foo
 * @namespace
 * @property {object}  bar - is this "bar" property?
 */
const foo = function foo() {
   //...
}

/**
 * Bar
 */
foo.bar = function bar() {
   //...
}

你也可以使用@alias，这完全取决于你的Foo和Bar;它们是对象，命名空间，函数，属性等。我建议您阅读JSDoc文档以了解所有可能性。

JSDoc - 如何将函数指定为另一个函数的属性

1 个答案: