{"meta":{"title":"Synchronisieren der Dokumentation mit Codeänderungen","intro":"Copilot Chat kann dabei helfen, die Code-Dokumentation aktuell zu halten.","product":"GitHub Copilot","breadcrumbs":[{"href":"/de/enterprise-cloud@latest/copilot","title":"GitHub Copilot"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials","title":"Anleitungen"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials/copilot-cookbook","title":"GitHub Copilot Kochbuch"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials/copilot-cookbook/document-code","title":"Dokumentcode"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials/copilot-cookbook/document-code/sync-documentation","title":"Synchronisieren der Dokumentation"}],"documentType":"article"},"body":"# Synchronisieren der Dokumentation mit Codeänderungen\n\nCopilot Chat kann dabei helfen, die Code-Dokumentation aktuell zu halten.\n\nEs kann schwierig sein, die Dokumentation mit Änderungen am Code auf dem neuesten Stand zu halten. Eine gute Dokumentation ist jedoch für das Aufrechterhalten von Codebasen und dafür essenziell, dass Entwickler effektiv mit dem Code arbeiten können.\nCopilot Chat kann beim Aktualisieren vorhandener Codedokumentation helfen.\n\n## Beispielszenario\n\nStelle dir ein Szenario vor, in dem eine TypeScript-Funktion die Produkte nach Kategoriename abruft, die Dokumentation jedoch veraltet ist.\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## Beispielaufforderung\n\nSie können Copilot Chat bitten, die Dokumentation gemäß dem aktuellen Code zu aktualisieren.\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## Beispielantwort\n\n> \\[!NOTE] Die folgende Antwort ist ein Beispiel. Da die Copilot Chat-Antworten nicht deterministisch sind, erhältst du möglicherweise eine andere Antwort als die hier beschriebene.\n\nCopilot erläutert, dass die aktualisierte Dokumentation für die `getByCategoryName` Funktion erstellt wird. Anschließend wird die aktualisierte Dokumentation bereitgestellt, die jetzt die Parameter `page` und `pageSize` sowie den Fehler `PrismaClientKnownRequestError` enthält, der ausgelöst werden kann.\n\nBeispiel:\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## Weiterführende Lektüre\n\n* [Prompt-Engineering für GitHub Copilot Chat](/de/enterprise-cloud@latest/copilot/concepts/prompting/prompt-engineering)\n* [Bewährte Methoden für die Verwendung von GitHub Copilot](/de/enterprise-cloud@latest/copilot/get-started/best-practices)"}