TSDoc

Definition

Standard de documentation pour TypeScript base sur JSDoc avec des tags normalises (@param, @returns, @example). Supporte par les IDEs et generateurs de docs.

Analogie

Comme les notices d'utilisation standardisees — meme format partout pour une comprehension universelle.

Exemple de code

/**
 * Calcule la TVA d'un montant.
 * @param amount - Le montant HT
 * @param rate - Le taux (defaut 0.2)
 * @returns Le montant TTC
 */
function withTax(amount: number, rate = 0.2) {}

Cas d'usage

Documenter les APIs publiques pour que les IDEs affichent l'aide contextuelle et generer la doc.

Anti-pattern

Termes lies