javascript - jsdoc 隐藏继承方法(在生成的文档中)

Question

我正在使用 jsdoc 为我的 javascript 项目生成在线文档。

它工作正常，除了我现在遇到的一个问题。

假设我有一个包含很多 get/set 函数的基类。

/**
 * cc.BaseClass
 * @class
 * @extends cc.Class
 */
cc.BaseClass = cc.Class.extend(/** @lends cc.BaseClass# */{
    /** 
     * @param {number} a
     */
    setA:function(a){},
    /** 
     * @return {number}
     */
    getA:function(){},
    // ...... 20+ more
});

然后我有一个扩展基类的子类。

/**
 * cc.ChildClass
 * @class
 * @extends cc.BaseClass
 */
cc.ChildClass = cc.BaseClass.extend(/** @lends cc.ChildClass# */{
    /** 
     * @param {number} xxx
     */
    myFunction:function(xxx){}
});

我的问题是为 cc.ChildClass 生成的在线 DOC 包含“myFunction:function”以及从 cc.BaseClass 继承的 20 多个获取/设置函数。

我知道这没有任何问题，但我想知道是否有办法在 cc.ChildClass 的文档中隐藏从 cc.BaseClass 继承的所有 20 多个 get/set 函数。

想想如果我有 cc.ChildClassA cc.ChildClassB cc.ChildClassC ... 那么我不想看到他们的每个文档都包含从 cc.BaseClass 继承的 20 多个获取/设置函数。

任何建议将不胜感激，谢谢:)

Answer 1

你不应该调整你的代码/类来满足这一点。这应该是模板的责任。这个技巧做得很好:https://github.com/steveush/foodoc - 演示:https://cancerberosgx.github.io/jsdoc-templates-demo/demo/foodoc/Apple.html .另一个支持它的是ibm的amddcl。在下面查找 https://cancerberosgx.github.io/jsdoc-templates-demo/demo/amddcl/Apple.html#

其他一些模板根本不显示继承，也不让用户调用 - 我也不想要。我认为 foodoc 允许用户和编译器人员很好地配置它。

顺便说一句，我正在尝试在此处收集众所周知的 jsdoc 模板演示 https://cancerberosgx.github.io/jsdoc-templates-demo/demo/ - 每个都有安装说明。