yuvrajkarna2717/react-hook-granth

[Docs]: Add JSDoc documentation to all hooks

オープン

#5 opened on 2025/12/06

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)JavaScript (1 件のフォーク)auto 404
documentationenhancementhelp wanted

Repository metrics

Stars
 (3 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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
}

コントリビューターガイド