Documenter un projet 📚

Les types de documentation

Prompt de documentation

CONTEXTE : Module auth.ts avec login/register/verifyToken/refreshToken
STACK : bcrypt, jsonwebtoken, prisma

TÂCHES :
1. JSDoc complet pour chaque fonction
2. README avec description, installation, config
3. Exemples d'utilisation concrets

LIVRABLE : Code mis à jour avec documentation intégrée

Bonnes pratiques

Résumé

• Spécifiez le type de documentation demandé
• Fournissez le code à documenter
• Demandez des exemples concrets
• Documentez par couches (architecture → modules → fonctions)

function calculateTotal(items, taxRate) {
  return items.reduce((sum, item) => sum + item.price * item.qty, 0) * (1 + taxRate);
}

/**
 * Calcule le total d'une commande avec taxes
 * @param {Array<{price: number, qty: number}>} items - Liste des articles
 * @param {number} taxRate - Taux de TVA (ex: 0.2 pour 20%)
 * @returns {number} Le total calculé avec taxes
 * @example
 * calculateTotal([{price: 10, qty: 2}], 0.2)
 * // Returns: 24
 */