{"meta":{"title":"Synchronisation de la documentation avec les modifications du code","intro":"Copilot Chat peut vous aider à conserver la documentation du code up-to-date.","product":"GitHub Copilot","breadcrumbs":[{"href":"/fr/copilot","title":"GitHub Copilot"},{"href":"/fr/copilot/tutorials","title":"Tutoriels"},{"href":"/fr/copilot/tutorials/copilot-cookbook","title":"livre de recettes GitHub Copilot"},{"href":"/fr/copilot/tutorials/copilot-cookbook/document-code","title":"Code du document"},{"href":"/fr/copilot/tutorials/copilot-cookbook/document-code/sync-documentation","title":"Documentation sur la synchronisation"}],"documentType":"article"},"body":"# Synchronisation de la documentation avec les modifications du code\n\nCopilot Chat peut vous aider à conserver la documentation du code up-to-date.\n\nIl peut être difficile de maintenir la documentation à jour avec les modifications apportées au code. Toutefois, une bonne documentation est essentielle pour gérer les bases de code et garantir que les développeurs peuvent travailler efficacement avec le code.\nCopilot Chat peut vous aider à mettre à jour la documentation de code existante.\n\n## Exemple de scénario\n\nImaginez un scénario dans lequel vous disposez d’une fonction TypeScript qui récupère les produits par nom de catégorie, mais la documentation est obsolète.\n\n```typescript id=fetch-products-by-category\n/**\n * Retrieves all products belonging to a specific category.\n * * @param categoryId - The unique identifier of the product category\n * @returns Promise that resolves to an array of Product objects\n * * @example\n * const products = await getByCategoryName(5);\n * // Returns: [{id: 1, name: \"Product 1\", categoryId: 5}, ...]\n * * @throws {PrismaClientKnownRequestError} If database query fails\n * @see {@link https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findmany}\n */\nasync getByCategoryName(categoryId: number, page = 1, pageSize = 10): Promise<Products[]> {\n  return await prisma.products.findMany({\n    where: { categoryId },\n    skip: (page - 1) * pageSize,\n    take: pageSize,\n    include: {\n      reviews: {\n        orderBy: { date: 'desc' },\n        take: 5,\n      },\n    },\n  });\n}\n```\n\n## Exemple d’invite\n\nVous pouvez demander Copilot Chat de mettre à jour la documentation en fonction du code actuel.\n\n```copilot copy prompt ref=fetch-products-by-category\nUpdate the existing documentation for the getByCategoryName function to reflect the current implementation.\n```\n\n## Exemple de réponse\n\n> \\[!NOTE] La réponse suivante est un exemple. Les réponses Copilot Chat ne sont pas déterministes, vous pouvez donc obtenir une réponse différente de celle affichée ici.\n\nCopilot explique qu’il créera la documentation mise à jour pour la fonction `getByCategoryName`. Il fournit ensuite la documentation mise à jour, qui inclut désormais les paramètres `page` et `pageSize`, ainsi que l'erreur `PrismaClientKnownRequestError` qui peut être déclenchée.\n\nPar exemple:\n\n```typescript\n/**\n * Retrieves all products belonging to a specific category with pagination and recent reviews.\n * * @param categoryId - The unique identifier of the product category\n * @param page - The page number for pagination (default: 1)\n * @param pageSize - Number of products per page (default: 10)\n * @returns Promise that resolves to an array of Product objects with their 5 most recent reviews\n * * @example\n * const products = await getByCategoryName(5, 2, 20);\n * // Returns: [{id: 1, name: \"Product 1\", categoryId: 5, reviews: [...5 recent reviews]}, ...]\n * * @throws {PrismaClientKnownRequestError} If database query fails\n * @see {@link https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findmany}\n */\n```\n\n## Lectures complémentaires\n\n* [Ingénierie rapide pour GitHub Copilot Chat](/fr/copilot/concepts/prompting/prompt-engineering)\n* [Meilleures pratiques pour l’utilisation de GitHub Copilot](/fr/copilot/get-started/best-practices)"}