Inline Code Documentation

Inline Code Documentation with JSDoc

All public TypeScript symbols exported from public-api.ts must be annotated with JSDoc comments. This includes:

Components – The component class must have a JSDoc description, and every input, output, and public method must be documented with @param, @returns, and an explanation. For signal‑based inputs, the comment is placed on the input() call.
Services – The class and every public method require JSDoc.
Interfaces, Types, and Enums – Each member must have a description.
Functions and Utilities – All exported standalone functions.

Example:

/**
* Represents a single filter option that can be toggled on or off.
  */
  export interface FilterOption {
  /** Unique identifier for the option. */
  id: string;
  /** Human‑readable label displayed to the user. */
  label: string;
  /** Whether the option is currently selected. */
  active: boolean;
  }

JSDoc comments should be concise but complete enough that a developer can understand the API without reading the implementation. Tags such as @deprecated, @internal, and @experimental must be used to communicate the support status of symbols.

General Rules

Documentation lives with the code. A pull request that introduces a new feature or a breaking change without appropriate README updates, JSDoc, and (if applicable) a migration file will not be merged.
All documentation must be written in English.
Links to external resources (e.g., Storybook, design tokens) must use permanent URLs that remain valid after version upgrades.

03 July 2026