# Sincronización de documentación con cambios de código

Chat de Copiloto puede ayudar a mantener la documentación del código up-to-date.

Mantener la documentación actualizada puede resultar difícil con los cambios en el código. Sin embargo, es esencial contar con una documentación óptima para mantener los códigos base y asegurarse de que los desarrolladores puedan trabajar de forma eficaz con el código.
Chat de Copiloto puede ayudar a actualizar la documentación de código existente.

## Escenario de ejemplo

Imagina un escenario en el que tienes una función de TypeScript que recupera productos por nombre de categoría, pero la documentación no está actualizada.

```typescript id=fetch-products-by-category
/**
 * Retrieves all products belonging to a specific category.
 * * @param categoryId - The unique identifier of the product category
 * @returns Promise that resolves to an array of Product objects
 * * @example
 * const products = await getByCategoryName(5);
 * // Returns: [{id: 1, name: "Product 1", categoryId: 5}, ...]
 * * @throws {PrismaClientKnownRequestError} If database query fails
 * @see {@link https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findmany}
 */
async getByCategoryName(categoryId: number, page = 1, pageSize = 10): Promise<Products[]> {
  return await prisma.products.findMany({
    where: { categoryId },
    skip: (page - 1) * pageSize,
    take: pageSize,
    include: {
      reviews: {
        orderBy: { date: 'desc' },
        take: 5,
      },
    },
  });
}
```

## Mensaje de ejemplo

Puede pedir que Chat de Copiloto actualice la documentación según el código actual.

```copilot copy prompt ref=fetch-products-by-category
Update the existing documentation for the getByCategoryName function to reflect the current implementation.
```

## Respuesta de ejemplo

> \[!NOTE] La respuesta siguiente es un ejemplo. Las respuestas de Chat de Copiloto no son deterministas, por lo que puedes obtener una respuesta diferente a la aquí mostrada.

Copilot explica que creará la documentación actualizada para la `getByCategoryName` función. A continuación, proporciona la documentación actualizada, que ahora incluye los parámetros `page` y `pageSize`, así como el error `PrismaClientKnownRequestError` que puede producirse.

Por ejemplo:

```typescript
/**
 * Retrieves all products belonging to a specific category with pagination and recent reviews.
 * * @param categoryId - The unique identifier of the product category
 * @param page - The page number for pagination (default: 1)
 * @param pageSize - Number of products per page (default: 10)
 * @returns Promise that resolves to an array of Product objects with their 5 most recent reviews
 * * @example
 * const products = await getByCategoryName(5, 2, 20);
 * // Returns: [{id: 1, name: "Product 1", categoryId: 5, reviews: [...5 recent reviews]}, ...]
 * * @throws {PrismaClientKnownRequestError} If database query fails
 * @see {@link https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findmany}
 */
```

## Lectura adicional

* [Ingeniería de mensajes para GitHub Copilot Chat](/es/enterprise-cloud@latest/copilot/using-github-copilot/prompt-engineering-for-github-copilot)
* [Procedimientos recomendados para usar GitHub Copilot](/es/enterprise-cloud@latest/copilot/using-github-copilot/best-practices-for-using-github-copilot)