我正在使用documentation
package,但不知道如何将其传递给文档类属性(不是通过getter和setter定义的)。
因为下面的代码只生成SomeClass的类文档,但省略了someProperty文档。
/**
* SomeClass is an example class for my question.
* @class
* @constructor
* @public
*/
class SomeClass {
constructor () {
this.someProperty = true // how do I document this?
}
/**
* someProperty is an example property that is set to `true`
* @property {boolean} someProperty
* @public
*/
}
顺便说一句: jsdoc类上的@constructor
是一个documentation
thing。
发布于 2018-07-23 02:09:25
将someProperty
的JSDoc移到首次定义它的构造函数中:
/**
* SomeClass is an example class for my question.
* @class
* @constructor
* @public
*/
class SomeClass {
constructor () {
/**
* someProperty is an example property that is set to `true`
* @type {boolean}
* @public
*/
this.someProperty = true
}
}
我不确定是否有一种方法可以使用documentation
package实现这一点,使用的方法不涉及将JSDocs内联到构造函数中。
发布于 2021-02-12 19:14:24
另一种方法是在类文档中声明它们,如下所示:
/**
* Class definition
* @property {type} propName - propriety description
* ...
*/
class ClassName {
constructor () {...}
...
}
https://stackoverflow.com/questions/51467835
复制相似问题