ES6类的JSDoc中,如何让子类继承父类构造函数文档?
解决JSDoc子类构造函数文档继承问题
针对你遇到的子类继承父类构造函数但文档网站不显示构造函数文档的问题,可以尝试以下几种方案:
方案一:显式定义子类构造函数并添加@inheritdoc
在子类中显式写出构造函数(即使仅调用super),并给构造函数添加@inheritdoc注解,让JSDoc明确继承父类的构造函数文档:
/** * @class * @extends Parent */ class Child extends Parent { /** * @inheritdoc */ constructor(someAttribute) { super(someAttribute); } }
方案二:在子类类注释中使用@borrows标签
通过@borrows标签直接将父类的构造函数文档关联到子类,无需显式定义构造函数:
/** * @class * @extends Parent * @borrows Parent#constructor as Child#constructor */ class Child extends Parent { }
方案三:检查JSDoc生成工具的配置
部分JSDoc生成工具需要开启特定配置才能自动继承构造函数文档:
- 原生JSDoc:确保配置文件(如
jsdoc.conf.json)中启用inheritDoc相关选项,或使用--inheritdoc命令行参数 - 其他衍生工具(如TypeDoc):检查配置是否开启了识别继承关系的相关选项,比如
includeDeclarations
内容的提问来源于stack exchange,提问作者jban28
相关产品推荐
相关产品推荐

