yuvrajkarna2717/react-hook-granth

[Docs]: Add JSDoc documentation to all hooks

开放

#5 创建于 2025年12月6日

 (0 条评论) (0 个反应) (0 位负责人)JavaScript (1 个派生)auto 404
documentationenhancementhelp wanted

仓库指标

星标
 (3 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Description: Add comprehensive JSDoc comments to all existing hooks for better IntelliSense and developer experience.

Requirements:

  • Add JSDoc comments to all hook functions
  • Include parameter descriptions
  • Include return value descriptions
  • Add usage examples in comments

Example:

/**
 * A hook that manages counter state with increment, decrement, and reset functionality.
 * 
 * @param initialValue - The initial counter value (default: 0)
 * @returns An object containing the current count and control functions
 * 
 * @example
 * ```tsx
 * const { count, increment, decrement, reset } = useCounter(10);
 * ```
 */
export default function useCounter(initialValue: number = 0) {
  // implementation
}

贡献者指南