注释规范

/**
 * @deprecated use MyClassEx instead of this.
 */
class MyClass{...}

/**
 * @example
 * let myClass = new MyClass();
 * let result = myClass.foo();
 * console.log(result);
 * 
 * @example
 * let result = MyClass.bar();
 * console.log(result);
 */
class MyClass{...}

/**
 * @ignore
 */
class MyClass{...}

/**
 * @todo support multi byte character.
 * @todo cache calculation result.
 */
class MyClass{...}

/**
 * @version 1.2.3
 */
class MyClass{...}

/**
 * @extends {SuperClass1}
 * @extends {SuperClass2}
 */
class MyClass extends mix(SuperClass1, SuperClass2) {...}

/**
 * @implements {MyInterface1}
 * @implements {MyInterface2}
 */
class MyClass {...}

/**
 * @interface
 */
class MyInterface {...}

class MyClass {
  /**
   * this method must be overridden by sub class.
   * @abstract
   */
  method(){...}
}

class MyClass extends SuperClass {
  /**
   * @override
   */
  method(){...}
}

class MyClass {
  /**
   * @param {number} p - this is p description.
   */
  method(p){...}
}

class MyClass {
  /**
   * @return {number} this is description.
   */
  method(){...}
}

class MyClass {
  /**
   * @throws {MyError1} throw error when foo.
   * @throws {MyError2} throw error when bar.
   */
  method(){...}
}

/** @test {MyClass} */
describe('MyClass has foo bar feature', () => {

  /** @test {MyClass#baz} */
  it('MyClass#baz returns magic value', () => {
    assert(true);
  });
});

/**
 * @param {number} param - this is simple param.
 */
function myFunc(param){...}

/**
 * @param {number[]} param - this is array param.
 */
function myFunc(param){...}

/**
 * @param {Object} param - this is object param.
 * @param {number} param.foo - this is property param.
 * @param {string} param.bar - this is property param.
 */
function myFunc(param){...}

/**
 * @param {{foo: number, bar: string}} param - this is object param.
 */
function myFunc(param){...}


/**
 * this is nullable property
 * @param {{foo: ?number, bar: string}} param - this is object param.
 */
function myFunc(param){...}

/**
 * this is object destructuring.
 * @param {{foo: number, bar: string}} param - this is object param.
 */
function myFunc({foo, bar}){...}

/**
 * @param {Array<string>} param - this is Array param.
 */
function myFunc(param){...}

/**
 * @param {Map<number, string>} param - this is Map param.
 */
function myFunc(param){...}

/**
 * @return {Promise<string[], MyError>} this is Promise return value.
 */
function myFunc(){...}

/**
 * @param {function(foo: number, bar: string): boolean} param - this is function param.
 */
function myFunc(param){...}

/**
 * @param {number|string} param - this is union param.
 */
function myFunc(param){...}

/**
 * @param {?number} param - this is nullable param.
 */
function myFunc(param){...}

/**
 * @param {!Object} param - this is not nullable param.
 */
function myFunc(param){...}

/**
 * @param {?(number|string)} param - this is nullable and union param.
 */
function myFunc(param){...}

/**
 * @param {...number} param - this is spread param.
 */
function myFunc(...param){...}

/**
 * @param {number} [param] - this is optional param.
 */
function myFunc(param){...}

/**
 * @param {number} [param=10] - this is default param.
 */
function myFunc(param){...}

/**
 * 使用Card.SimpleCard组件
 */
const { SimpleCard } = Card;

/**
 * item 说明变量用途
 */
const item = {};

/**
 * MyComponent 自定义React组件
 * @extends {PureComponent} - React.PureComponent
 * @reactProps {?string} [className=my-component] - 组件react className属性
 * @return {Object} React.element
 * @example
 * import React from 'react';
 * import { FormItem } from 'components/MyComponent';
 *
 * const Test = (props) => {
 *   return (
 *     <MyComponent />
 *   );
 * };
 */
class MyComponent extends React.PureComponent {
  render(){...}
}

/**
 * MyComponent 自定义React组件
 * @author yourname <yourname@hand-china.com>
 * @extends {PureComponent} - React.PureComponent
 * @reactProps {?string} [className=my-component] - 组件react className属性
 * @return {Object} React.element
 * @example
 * import React from 'react';
 * import { FormItem } from 'components/MyComponent';
 *
 * const Test = (props) => {
 *   return (
 *     <MyComponent />
 *   );
 * };
 */
class MyComponent extends React.PureComponent {
  render(){...}
}

import {
  query,
} from '../../services/testService';

export default {
  namespace: 'test', // 测试model
  state: {
    code: {}, // 编码
    list: [], // 数据集合
  },
  effects: {
    // 查询list数据
    *query({ payload }, { put, call }) {
      const response = yield call(query, payload);
      if (response && !response.failed) {
        yield put({
          type: 'updateStateReducer',
          payload: {
            list: response
          },
        });
      }
    },
  },
  reducers: {
    // 合并state状态数据,生成新的state
    updateStateReducer(state, { payload }) {
      return {
        ...state,
        ...payload,
      };
    },
  },
};

/**
 * 查询 说明接口逻辑用途
 * @async
 * @function queryMembers 接口函数名称
 * @param {object} params - 接口参数
 * @param {!number} [params.page = 0] - 数据页码
 * @param {!number} [params.size = 10] - 分页大小
 * @returns {object} fetch Promise 默认返回值
 */
 export async function query(params) {
  return request('/api', { query: params });
}