Question

我试图将JSDoc添加到大多数来源遵循以下准则的项目中：

脚本是定义类的AMD模块（它们导出构造函数）
建筑师真的是工厂;如果省略this，它们会返回匿名对象（而不是填充new）以避免意外行为。

我想使用JSDoc记录这个，但是＆＃34;正确使用＃34;目前涉及的似乎是很多冗余：

/**
 * These are my docs for SomeClass.
 * @module path/to/some-module
 */
define(
    /** @lends module:path/to/some-module */
    function () {

        /**
         * Construct some object.
         * @constructor
         */
        function SomeClass(a, b, c) {
            var somePrivateVariable;

            function somePrivateFunction() {}

            return {
                /** @memberof module:path/to/some-module~SomeClass# */
                someMethod: function () {},

                /** @memberof module:path/to/some-module~SomeClass# */
                someOtherMethod: function () {}
            };
        }
        return SomeClass;
    }
);

我想缩短这一点。特别是漫长的路径＆＃34;毕竟那些@memberof标签是繁琐而嘈杂的，特别是当有很多方法时。 @lends也很烦人，因为从人类读者的角度来看，它是完全多余的。

如果没有重写或重构代码本身，有没有更好的方法呢？

如何使用AMD模块和工厂式构造函数编写简洁的JSDoc？

0 个答案: