JSDoc - 如何将函数分配为另一个函数的 属性
JSDoc - How to assign a function as a property of another function
鉴于以下情况，当我 运行 jsdoc 时，foo.bar 属性.
的输出没有显示任何内容
/**
* Foo
*/
const foo = function foo() {
//...
}
/**
* Bar
*/
foo.bar = function bar() {
//...
}
如何将 bar 显示为 foo 上的 属性？
实现这一目标的可能性有很多。以下只是其中的几个......
使用 @memberof 标签标识属于父符号的成员符号。
/**
* Foo
*/
const foo = function foo() {
//...
}
/**
* Bar
* @memberof Foo
*/
foo.bar = function bar() {
//...
}
使用 @prop 标记轻松记录 class、命名空间或其他对象的静态属性列表。
/**
* Foo
* @namespace
* @property {object} bar - is this "bar" property?
*/
const foo = function foo() {
//...
}
/**
* Bar
*/
foo.bar = function bar() {
//...
}
您可以使用 @alias as well, it's all depend on what is your Foo and Bar; Are they objects, namespace, functions, properties, etc. I would suggest to read a bit on JSDoc 文档来了解所有可能性。
鉴于以下情况，当我 运行 jsdoc 时，foo.bar 属性.
/**
* Foo
*/
const foo = function foo() {
//...
}
/**
* Bar
*/
foo.bar = function bar() {
//...
}
如何将 bar 显示为 foo 上的 属性？
实现这一目标的可能性有很多。以下只是其中的几个......
使用 @memberof 标签标识属于父符号的成员符号。
/** * Foo */ const foo = function foo() { //... } /** * Bar * @memberof Foo */ foo.bar = function bar() { //... }使用 @prop 标记轻松记录 class、命名空间或其他对象的静态属性列表。
/** * Foo * @namespace * @property {object} bar - is this "bar" property? */ const foo = function foo() { //... } /** * Bar */ foo.bar = function bar() { //... }
您可以使用 @alias as well, it's all depend on what is your Foo and Bar; Are they objects, namespace, functions, properties, etc. I would suggest to read a bit on JSDoc 文档来了解所有可能性。