chore: Standardize comment format to JSDoc-style syntax

[cpcramer]

What changed? Why?

chore: Standardize comment format to JSDoc-style syntax

We're implementing a consistent approach to documentation comments across our codebase. This will improve readability and make our documentation more maintainable.

New Comment Standards

1. Multi-line comments (/** */) for:

   • Function definitions
   • Class definitions
   • Type/Interface definitions
   • Complex exports

2. Single-line comments (/** */) for:

   • Properties within types/interfaces
   • Simple constants
   • Basic exports

3. Regular comments (//) for:

   • Inside function implementations
   • Implementation details
   • Temporary notes
   • Line-by-line explanations

Example:

/**
 * Note: exported as public Type
 */
export type isEthereumOptions = {
  /** Chain ID for the network */
  chainId: number;
  /** If the chainId check is only allowed on mainnet */
  isMainnetOnly?: boolean;
};

/**
 * DismissableLayer handles dismissal using outside clicks and escape key events
 */
export function DismissableLayer({}) {
      // This prevents the popover from closing when clicking inside it
      if (layerRef.current?.contains(event.target as Node)) {
        return;
      }

      // Handling for the trigger button (e.g., settings toggle)
      // Without this, clicking the trigger would cause both:
      // 1. The button's onClick to fire (toggling isOpen)
      // 2. This dismissal logic to fire (forcing close)
      // This would create a race condition where the popover rapidly closes and reopens
      const isTriggerClick = (event.target as HTMLElement).closest(
        '[aria-label="Toggle swap settings"]',
      );
}

Result:

Notes to reviewers

How has it been tested?

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
onchainkit-coverage	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 4:52pm
onchainkit-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 4:52pm
onchainkit-routes	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 4:52pm

[brendan-defi]

non-blocking: i don't know what a reference amount is, and this comment doesn't help me understand