【问题标题】:JSDoc nested function dosen't make docJSDoc 嵌套函数不生成文档
【发布时间】:2019-11-25 13:56:13
【问题描述】:

JSDoc 嵌套函数不生成文档。 我看到https://jsdoc.app/tags-mixin.html,这对我不起作用。 我不会在我的文档中制作文档。

装饰器 Mixin 如何为我工作? 我会很感激你的回答。

这是我的代码。


/**
 * @class angular_service.PrivilegeService
 * @memberOf angular_service
 * @name PrivilegeService
 * @description none
 */
app.service("PrivilegeService", [
  "$parse",
  "Auth",
  "Const",
  "$location",
  "$timeout",
  function($parse, Auth, Const, $location, $timeout) {
    var idx,
      loginUserInfo,
      privilege,
      permissionType = Const.PERMISSION_TYPE;

    /**
     * @mixin
     */
    var privilegeService = {
      /**
       * @param {string}  moduleName
       * @description module import
       */
      getModuleId: function(moduleName) {
        var moduleId = "";
        for (var key in Const.PERMISSION_MODULE_ID) {
          if (Const.PERMISSION_MODULE_ID.hasOwnProperty(key)) {
            if (key == moduleName) {
              moduleId = Const.PERMISSION_MODULE_ID[key];
              break;
            }
          }
        }
        return moduleId;
      },
      /**
       * @param {string}  moduleId
       * @description find out id
       */
      getModuleNameByModuleId: function(moduleId) {
        var moduleName = "";
        for (var key in Const.PERMISSION_MODULE_ID) {
          if (Const.PERMISSION_MODULE_ID.hasOwnProperty(key)) {
            if (Const.PERMISSION_MODULE_ID[key] == moduleId) {
              moduleName = key;
              break;
            }
          }
        }
        return moduleName;
      }

【问题讨论】:

    标签: javascript node.js frontend jsdoc


    【解决方案1】:

    以下是需要的文档的一种方法

    /**
     * @class angular_service.PrivilegeService
     * @memberOf angular_service
     * @name PrivilegeService
     * @description none
     */
    app.service("PrivilegeService", [
      "$parse",
      "Auth",
      "Const",
      "$location",
      "$timeout",
      function($parse, Auth, Const, $location, $timeout) {
        var idx,
          loginUserInfo,
          privilege,
          permissionType = Const.PERMISSION_TYPE;
     /**
     * @function privilegeService
     * @memberof angular_service.PrivilegeService
     * @mixin
     */
        var privilegeService = {
           /**
             * @function getModuleId
             * @memberof angular_service.PrivilegeService.privilegeService
             * @param {string}  moduleName
             * @description module import
             */
            getModuleId: function(moduleName) {
              var moduleId = "";
              for (var key in Const.PERMISSION_MODULE_ID) {
                if (Const.PERMISSION_MODULE_ID.hasOwnProperty(key)) {
                  if (key == moduleName) {
                    moduleId = Const.PERMISSION_MODULE_ID[key];
                    break;
                  }
                }
              }
              return moduleId;
            },
            /**
             * @function getModuleNameByModuleId
             * @memberof angular_service.PrivilegeService.privilegeService
             * @param {string}  moduleId
             * @description find out id
             */
            getModuleNameByModuleId: function(moduleId) {
              var moduleName = "";
              for (var key in Const.PERMISSION_MODULE_ID) {
                if (Const.PERMISSION_MODULE_ID.hasOwnProperty(key)) {
                  if (Const.PERMISSION_MODULE_ID[key] == moduleId) {
                    moduleName = key;
                    break;
                  }
                }
              }
              return moduleName;
            }
        }
    });
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2018-03-09
      • 1970-01-01
      • 2015-06-23
      • 2014-03-04
      • 2023-04-10
      • 1970-01-01
      • 2014-01-17
      • 2021-01-12
      相关资源
      最近更新 更多