jsdoc - 为什么 JSDoc 将所有 JS 模块的文档注释合并到一个文件中？

Question

我在一个目录中有多个 JS 文件（AMD 模块）。当我运行 jsdoc 命令时，它会生成一个 index.html 文件，其中包含所有文件中所有方法的文档注释。为什么将所有方法合并到一个文件中？

我正在使用以下命令

jsdoc D:\JSworks\shell\widgets -r -d D:\output

我希望 index.html 具有指向每个模块的链接，单击它应该显示仅该特定模块的方法的文档。我该如何做到这一点？

Answer 1

我不知道您的类的外观如何，但这里有一个示例，说明如何注释 AMD 模块以便 JSDoc 为其正确生成文档：

/**
 * A Model for users
 * @module  UserModel
 * @exports UserModel
 * @extends AbstractModel
 */

define(["model/AbstractModel"], 
function(AbstractModel ) {

    return UserModel = new Class(
        /** @lends module:UserModel */
        {
            Extends : AbstractModel,

            /**
             * Constructor
             * @memberOf module:UserModel#
             */

            initialize: function() {
                this.parent();
            },

            /**
             * Sets the model value
             * @memberOf module:UserModel#
             * @param {object} value Value to set the model to           
             */

             setValue: function(value){
                // do something
             }

            /**
             * Responsible for returning user metadata
             * @memberOf module:UserModel#
             * @param {object} user User
             */

            getMetaData: function(user) {
                // do something
            }
        }
    );
});

此类将生成以下文档：

在 JSDOC 中使用的完整标签列表可在http://usejsdoc.org/index.html#JSDoc3_Tag_Dictionary获得

Answer 2

您还可以为所有 AMD 依赖项添加 @require 模型/AbstractModel（参见先前的答案）和 @require。

我认为@lends 注释不适用于新的 Class()。