使用自定义继承系统记录复杂的 JavaScript 对象答案

【问题标题】：Documenting complex JavaScript Objects with custom Inheritance System使用自定义继承系统记录复杂的 JavaScript 对象
【发布时间】：2014-04-10 08:37:59
【问题描述】：

我目前正在尝试将现有的服务器端 JavaScript API 从现有的手动复制和粘贴继承系统迁移到更好、更可靠的系统。不能使用纯原型，因为对象的状态（变量）也必须被继承，并且不能在父对象中被覆盖。

所以我正在考虑使用 John Reisig 描述的一个好的解决方案： http://ejohn.org/blog/simple-javascript-inheritance/

哪些工人最适合我的情况。

我现在面临的唯一挑战是大多数文档框架不会处理这样构造的对象（或者我只是不知道如何告诉它们）。所以我的问题是，我怎样才能像这样记录类：

namespace.ClassA = Class.extend({
    name : "",

    init: function(name){
        this.name = name;
    }
});

namespace.ClassB = ClassA.extend({
    sayName : function(){
        console.log(this.name);
    }
});

我更喜欢 JsDoc，但我想不出用 JsDoc 来记录这种类的方法。我还尝试了 NaturalDocs，它可以工作，但我真的不希望所有这些额外的 python 东西都在构建过程中。

我认为我遇到的主要问题是命名空间

例如：

    /** @memberof namespace**/
    namespace.ClassB = ClassA.extend(
    /** @lends ClassB.prototype **/
    {
            /** @constructs **/
            init : function(){
            },

    sayName : function(){
        console.log(this.name);
    }
});

不会在命名空间“命名空间”中包含或显示 ClassB

【问题讨论】：

Jsdoc 能够为您推断出很多东西，只要您使用它理解的样式。如果你不这样做，仍然可以明确告诉 jsdoc 你的意思。您只需要在文档中更加详细（使用更多@ 标签）。为了帮助我们提供一个符合要求的答案，如果您能向我们展示您尝试过的内容以及为什么它不让您满意，这将对我们有所帮助。否则，很容易提供会产生某些结果的答案，只是让您回复不是您想要的，等等。

标签： javascript documentation ecmascript-5 jsdoc jsdoc3

【解决方案1】：

看看以下是否适合你。请注意，您的代码 sn-p 本身不是有效的 JavaScript，因为 namespace 没有在任何地方定义。无论如何，jsdoc 都会处理它。我必须做的是比我本来应该做的更冗长。几点说明：

您可以将定义ClassA 的doclet 放在具有namespace.ClassA 的行前面。
@lends 标签需要完整路径：/** @lends namespace.ClassB.prototype */

代码如下：

/**
 * @namespace namespace
 */

namespace.ClassA = Class.extend({
    name : "",

    /**
     * @constructor
     * @memberof namespace
     * @name ClassA
     * @param name Blah.
     */
    init: function(name){
        this.name = name;
    }
});

/**
 * @constructor
 * @memberof namespace
 * @name ClassB
 */
namespace.ClassB = ClassA.extend(/** @lends namespace.ClassB.prototype */ {
    /**
     * @method
     */
    sayName : function(){
        console.log(this.name);
    }
});

【讨论】：

真的很好！非常感谢！