如何使用JSDoc记录ES6类属性
如何使用JSDoc记录ES6类属性
提问于 2018-07-23 01:55:48
我正在使用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。
回答 2
Stack Overflow用户
回答已采纳
发布于 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内联到构造函数中。
Stack Overflow用户
发布于 2021-02-12 19:14:24
另一种方法是在类文档中声明它们，如下所示：
/**
* Class definition
* @property {type} propName - propriety description
* ...
*/
class ClassName {
constructor () {...}
...
}页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/51467835
复制相关文章
相似问题