使用代码更改同步文档

随着对代码进行更改，使文档保持最新可能很困难。 然而，良好的文档对于维护代码库和确保开发人员能够有效地使用代码至关重要。 Copilot Chat 可帮助更新现有代码文档。

示例方案

假设有一个 TypeScript 函数，该函数按类别名称检索产品，但文档已过期。

/**
 * 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,
      },
    },
  });
}

示例提示

可以让 Copilot Chat 根据当前代码更新文档。

Update the existing documentation for the getByCategoryName function to reflect the current implementation.

示例响应

Copilot 说明它将为 getByCategoryName 函数创建更新的文档。 然后，它提供更新的文档，其中现在包括 page 和 pageSize 参数，以及可能引发的 PrismaClientKnownRequestError 错误。

例如：

/**
 * 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}
 */

其他阅读材料

• “GitHub Copilot 的提示设计”
• “有关使用 GitHub Copilot 的最佳做法”