JS 文档注释

/** JSDoc comment */

只比 普通多行注释多一个*，即可使用 JSDoc comment，可以在该注释里使用 markdown 编写注释信息。在使用有 js 文档注释方法时，鼠标悬停该方法即可看到注释信息。

@ 约定注释前缀格式

/**
 * @description 描述信息
 * @param paramName 参数描述
 * @returns 返回值信息
 * @category 分类 一般置于文档最下方
 */

使用 markown

/**
 * ### 使用用例
 *
 * ```typescript
 *
 *    // 500ms内多次点击只会触发一次
 *
 *   const debounceFn = useDebounceFn(f1, 500, [state]);
 *
 *   function f1(a: string, b: number) {
 *     console.log('a1===>', a);
 *     console.log('b===>', b);
 *     console.log('state===>', state);
 *     setTimeout(() => {
 *       console.log('a2===>', a);
 *     }, 2000);
 *    }
 *  <div onClick={() => debounceFn('aaa', 12)}>测试按钮</div>
 * ```
 * @category react hooks
 */

export declare function useDebounceFn<T>(
  func: (...arg: T[]) => void,
  delay: number,
  dep: React.DependencyList
): (...args: T[]) => void;

效果