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

除了我现在遇到的一个问题以外,它都可以正常工作.

说我有很多获取/设置函数的基类.

/**
 * 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个get / set函数.

我知道这没有错,但是我想知道是否有办法隐藏cc.ChildClass的文档中从cc.BaseClass继承的所有20个get / set函数.

想想如果我有cc.ChildClassA cc.ChildClassB cc.ChildClassC …那么我不想看到他们的每个文档都包含从cc.BaseClass继承的20个get / set函数.

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

解决方法:

您不应该修改您的代码/类来满足此要求.这应该是模板的责任.这个技巧很好：https://github.com/steveush/foodoc-demo：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/-每个都有安装说明.