Question

JSDoc嵌套函数无法生成doc。我看到了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;
      }

Answer 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;
        }
    }
});

JSDoc嵌套函数无法生成doc

1 个答案: