github copilot prompts cheatsheet

GitHub Copilot Chat 提供了许多以 @ 开头的指令来提高用户与其交互的便捷性。以下是一些常见的示例：

@show documentation for symbol:
```
@show documentation for `fetchData`
```
描述: 显示 fetchData 函数的文档。
@explain code:
```
@explain code
```
描述: 对当前选定的代码段进行解释。
@fix errors:
```
@fix errors
```
描述: 修复当前文件中的错误。
@generate tests:
```
@generate tests
```
描述: 为当前代码生成测试用例。
@refactor symbol:
```
@refactor `oldFunction`
```
描述: 重构 oldFunction 函数。
@complete function symbol:
```
@complete function `calculateTotal`
```
描述: 完成 calculateTotal 函数的实现。
@add comments:
```
@add comments
```
描述: 为当前代码添加注释。
@document file:
```
@document file
```
描述: 为当前文件生成文档注释。
@find references:
```
@find references
```
描述: 查找当前选定的符号的所有引用。
@debug symbol:
```
@debug `myFunction`
```
描述: 调试 myFunction 函数。
@add type annotations:
```
@add type annotations
```
描述: 为当前代码添加类型注释。
@optimize imports:
```
@optimize imports
```
描述: 优化当前文件的导入语句。
@run tests:
```
@run tests
```
描述: 运行当前项目的测试。
@update dependencies:
```
@update dependencies
```
描述: 更新项目的依赖项。
@check performance:
```
@check performance
```
描述: 检查当前代码的性能。
@suggest improvements:
```
@suggest improvements
```
描述: 为当前代码提供改进建议。
@translate comments:
```
@translate comments
```
描述: 翻译代码中的注释。
@generate documentation site:
```
@generate documentation site
```
描述: 为当前项目生成文档站点。
@add logging:
```
@add logging
```
描述: 为当前代码添加日志记录。
@check security:
```
@check security
```
描述: 检查当前代码的安全性。

这些指令能帮助开发者更高效地编写、调试和优化代码，同时也能增强代码的可读性和维护性。

以下是一些类似于 @file 的 GitHub Copilot Chat 指令示例：

@file:
```
@file
```
描述: 针对当前文件的操作或信息查询。
@function:
```
@function
```
描述: 针对当前选定的函数进行操作或查询。
@variable:
```
@variable
```
描述: 针对当前选定的变量进行操作或查询。
@class:
```
@class
```
描述: 针对当前选定的类进行操作或查询。
@method:
```
@method
```
描述: 针对当前选定的方法进行操作或查询。
@property:
```
@property
```
描述: 针对当前选定的属性进行操作或查询。
@module:
```
@module
```
描述: 针对当前选定的模块进行操作或查询。
@constructor:
```
@constructor
```
描述: 针对当前选定的构造函数进行操作或查询。
@loop:
```
@loop
```
描述: 针对当前选定的循环进行操作或查询。
@conditional:
```
@conditional
```
描述: 针对当前选定的条件语句进行操作或查询。
@comment:
```
@comment
```
描述: 针对当前选定的注释进行操作或查询。
@annotation:
```
@annotation
```
描述: 针对当前选定的注释进行操作或查询。
@block:
```
@block
```
描述: 针对当前选定的代码块进行操作或查询。
@line:
```
@line
```
描述: 针对当前选定的代码行进行操作或查询。
@region:
```
@region
```
描述: 针对当前选定的代码区域进行操作或查询。

这些指令有助于开发者在不同的代码结构层次上进行精细化操作或信息查询，提高开发效率和代码质量。

以下是一些以 / 开头的 GitHub Copilot Chat 指令示例：

/explain:
```
/explain
```
描述: 对当前选定的代码段进行解释。
/fix:
```
/fix
```
描述: 修复当前文件中的错误。
/generate tests:
```
/generate tests
```
描述: 为当前代码生成测试用例。
/refactor:
```
/refactor
```
描述: 重构当前选定的代码段。
/complete:
```
/complete
```
描述: 完成当前选定的函数或代码段的实现。
/add comments:
```
/add comments
```
描述: 为当前代码添加注释。
/document:
```
/document
```
描述: 为当前文件生成文档注释。
/find references:
```
/find references
```
描述: 查找当前选定的符号的所有引用。
/debug:
```
/debug
```
描述: 调试当前选定的代码段。
/add type annotations:
```
/add type annotations
```
描述: 为当前代码添加类型注释。
/optimize imports:
```
/optimize imports
```
描述: 优化当前文件的导入语句。
/run tests:
```
/run tests
```
描述: 运行当前项目的测试。
/update dependencies:
```
/update dependencies
```
描述: 更新项目的依赖项。
/check performance:
```
/check performance
```
描述: 检查当前代码的性能。
/suggest improvements:
```
/suggest improvements
```
描述: 为当前代码提供改进建议。
/translate comments:
```
/translate comments
```
描述: 翻译代码中的注释。
/generate documentation site:
```
/generate documentation site
```
描述: 为当前项目生成文档站点。
/add logging:
```
/add logging
```
描述: 为当前代码添加日志记录。
/check security:
```
/check security
```
描述: 检查当前代码的安全性。

这些指令有助于开发者更高效地与代码交互，完成各种常见的开发任务和代码优化。

在使用 GitHub Copilot Chat 时，除了使用 @ 和 / 开头的指令外，还有一些实用的技巧和最佳实践可以帮助你更高效地利用该工具：

一般技巧

明确的问题描述:

// Bad: Fix this.
// Good: Fix the bug where the function returns the wrong value when input is negative.

描述: 提供详细的问题描述，以获得更准确的建议和代码生成。

分步提问:

// Instead of asking for a complete solution, break it down.
// Step 1: Generate a function skeleton
// Step 2: Ask to implement a specific part

结合现有代码:

// Provide context with existing code for better suggestions.
// Good: Given the following function, add error handling.
// ```
// function fetchData() {
//   // Existing code here
// }
// ```

利用注释:

// Add comments to guide Copilot.
// Example:
// Generate a function to calculate the sum of an array.
// ```
// // Function to calculate the sum of an array
// function calculateSum(arr) {
//   // ...
// }
// ```

命名约定:

// Use clear and descriptive names for functions and variables.
// Good: generateReport(data)
// Bad: func1(d)

利用已有代码块:

// Copilot can autocomplete based on patterns in your codebase.
// Example: If you have similar functions, start typing and let Copilot suggest.

高级技巧

多语言支持:

// Use Copilot to help translate code between languages.
// Example: Convert Python function to JavaScript.

生成文档:

// Use Copilot to generate documentation comments.
// Example:
// /**
//  * Calculates the sum of an array.
//  * @param {number[]} arr - The array of numbers.
//  * @returns {number} The sum of the numbers.
//  */

代码优化建议:

// Ask Copilot for optimization tips.
// Example: Optimize this loop for better performance.

单元测试生成:

// Request unit tests for functions.
// Example: Generate unit tests for `calculateSum` function.

安全性检查:

// Use Copilot to identify potential security issues.
// Example: Check this code for SQL injection vulnerabilities.

综合运用示例

// Combining various techniques in a single workflow:
@file

// Step 1: Generate a function skeleton
/**
 * Calculates the sum of an array.
 * @param {number[]} arr - The array of numbers.
 * @returns {number} The sum of the numbers.
 */
function calculateSum(arr) {
  // TODO: Implement this function
}

// Step 2: Ask for detailed implementation
@function calculateSum

// Implement the function to sum an array of numbers

// Step 3: Generate tests for the function
@generate tests for calculateSum

// Step 4: Optimize the function for large datasets
@optimize calculateSum for large datasets

// Step 5: Add type annotations (if using TypeScript)
@add type annotations to calculateSum

// Step 6: Check the function for security vulnerabilities
@check security of calculateSum

通过这些技巧和示例，你可以充分利用 GitHub Copilot Chat 来提高编程效率和代码质量。

zking2000 / NotePad