Question

我正在努力让我的JS文档正确。我正在使用Dojo，以及其上构建的其他一些复杂的框架，我将不再提供详细信息。重点是该框架使用的是AMD模块。我想让我的JSDoc工作。

这是我到目前为止所做的：

/**
 * Creates a button instance that launches a document entry template selector
 * @module widgets/instance/AddButton
 */
define([
    "dijit/_TemplatedMixin",
    "dijit/_WidgetBase",
    "dojo/_base/declare",
    "dojo/_base/lang",
    "dojo/on",
    "kwcn/services/request",
    "kwcn/widgets/AddContentDialog"
], function (_TemplatedMixin, _WidgetBase, declare, lang, on, request, AddContentDialog) {
    return declare('AddButton', [_WidgetBase, _TemplatedMixin], /** @lends module:widgets/instance/AddButton */{
        id: 'add-button',
        contentList: null,
        templateString: '<button class="btn btn-link toolbar-link"><i class="fa fa-lg fa-file"></i> Add Document</button>',
        addContentItem: null,
        type: null,
        /**
         * @constructs
         * @param args
         * @param args.type {string} The type of content item
         * @param args.contentList {ContentList} The instance of [ContentList]{@link module:widgets/contentList/ContentList} in scope
         */
        constructor: function (args) {
            declare.safeMixin(this, args);
        },
        /**
         * @private
         */
        postCreate: function () {
            console.log("creating the add content button...");
            this.addContentItem = new AddContentDialog({
                repository: request.repository(),
                hasCase: false
            });
            this.own(on(this.domNode, 'click', lang.hitch(this, 'show')));
        },
        /**
         * @public
         */
        show: function () {
            request.inboundFolder().then(lang.hitch(this, function (folder) {
                this.addContentItem.showAddDocument(null, folder);
            }));
        }
    });
});

结果： enter image description here

这个结果还不错。但它推断我的成员是静态的。 WebStorm似乎正确地将它们推断为成员，但jsdoc3生成器却没有。从我读到的，我不应该指定@memberof，因为@lends应该照顾它。有什么我做错了吗？任何一般性建议将不胜感激。我阅读了JSDoc3文档，但是在将AMD添加到等式中时，很多结构看起来都很模糊。

Answer 1

您需要将实例属性提供给原型，而不是对象本身：@lends module:widgets/instance/AddButton#。注意＃末尾的＃，这是.prototype的简写。

另请注意，jsdoc3有很多与其处理非CommonJS模块有关的错误，所以你可能需要做额外的hacky东西才能使它正常工作。

JSDoc3与Dojo和AMD

1 个答案: