copilot-dev: Command for Claude Code

Add complete, accurate documentation to all public functions, classes, and methods in the following code:

Code to document: ${selection}

If no code is selected, document the file: ${file}

---

Documentation standards by language

Detect the language automatically from the file extension or syntax, then apply the correct standard.

---

TypeScript / JavaScript — JSDoc

Add JSDoc comments above every:

• Exported function
• Exported class (and its public methods)
• Exported type / interface (if complex)
• Exported constant (if non-obvious)

Do not document:

• Internal/private helpers (prefixed _ or not exported)
• Simple pass-through functions where the name is self-documenting
• Test files

JSDoc template

/**
 * [One-sentence summary of what this function does — active voice, starts with a verb]
 *
 * [Optional: 1-2 additional sentences for complex behavior, edge cases, or important caveats.
 *  Omit this paragraph if the one-liner is sufficient.]
 *
 * @param paramName - [Description of what this parameter represents. Include type constraints
 *   if not obvious from the TypeScript type. E.g., "Must be a positive integer", "Cannot be empty."]
 * @param optionalParam - [Description.] Defaults to `defaultValue`.
 * @returns [What the function returns. If it returns an object, describe the shape.
 *   If it returns a Promise, describe what the resolved value contains.]
 * @throws {ErrorType} [When/why this error is thrown.]
 *
 * @example
 * ```typescript
 * // [Brief description of what this example demonstrates]
 * const result = myFunction('input', { option: true })
 * // result: { id: 'abc', status: 'ok' }
 * ```
 */
export function myFunction(paramName: string, optionalParam = 'default'): SomeType {

Class documentation

/**
 * [What this class represents — its role in the system, what it encapsulates]
 *
 * [Optional: design pattern used (e.g., "Implements the Repository pattern for..."),
 *  or key invariant the class maintains]
 *
 * @example
 * ```typescript
 * const service = new TipService({ dataPath: './data/tips.json' })
 * const tips = await service.search('keyboard')
 * ```
 */
export class TipService {
  /**
   * Creates a new TipService instance.
   *
   * @param config - Configuration options for the service.
   * @param config.dataPath - Absolute or relative path to the tips JSON data file.
   * @param config.cacheEnabled - When true, caches search results for 60 seconds.
   *   Defaults to `false`.
   */
  constructor(config: TipServiceConfig) {}

  /**
   * Searches tips by keyword across title, description, and tags fields.
   *
   * Search is case-insensitive. Returns all tips when query is an empty string.
   *
   * @param query - The search term. Pass an empty string to return all tips.
   * @returns Array of tips matching the query, sorted by relevance score descending.
   *   Returns an empty array (not null) when no results match.
   * @throws {TypeError} When query is null or undefined.
   *
   * @example
   * ```typescript
   * const results = await service.search('keyboard shortcut')
   * console.log(results.length)  // e.g., 3
   * console.log(results[0].title)  // e.g., "Accept suggestion with Tab"
   * ```
   */
  async search(query: string): Promise<Tip[]> {}
}