最好使用 linter 检查代码中是否存在潜在错误、样式违规或与最佳做法的偏差。 Linter 可以帮助尽早捕获 bug,提高代码的可读性,并确保代码保持一致且可维护。
示例方案
已对代码运行了 linter,并且它已识别一些需要修复的问题。 可以让 Copilot Chat 为你修复这些问题,而不是手动修复。
示例提示
-
选择编辑器中的所有代码,然后键入:
Fix the lint errors
-
可以针对语言指定一组特定的编码准则,例如为 Python 指定 PEP8:
Use PEP8 to fix the lint errors
-
如果你有一个定义编码约定和规则的本地文件,可以将该文件拖到聊天窗口中以将其添加为附件,然后键入:
Use the attached style guide to fix the lint errors
-
或者,可以让 Copilot Chat 仅修复特定类型的 lint 错误:
Make sure all functions use snake_case naming style
示例响应
Copilot 会告诉你需要更改哪些内容,然后提供更正后的代码。 在使用建议的代码之前,应对其进行仔细评审。 Copilot 建议的代码可能无法修复 linter 标识的所有问题,因此,如果选择使用建议的代码,应始终再次运行 linter。
Copilot 可帮助修复的 Lint 问题包括:
- 添加缺少的必要导入。
- 移除代码中未使用的导入。
- 将导入语句拆分为单独的行。
- 使用遵循样式准则的方法和函数名称。
- 在运算符周围添加空格。
- 确保一致的缩进。
- 移除尾随空格。
- 将单行中的多个语句拆分为单独的行。
- 将长行分解为多行。
- 移除未使用的变量。
- 添加或移除空白行以遵循样式准则。
- 向函数、类和模块添加文档字符串。
- 移除永远不会执行的代码。
- 确保函数中的所有返回语句都返回一个值或不返回任何内容。
- 减少或消除全局变量的使用。
- 确保使用正确的参数数量和类型调用函数。
- 确保注释放置正确且有意义。
- 将 print 语句替换为正确的日志记录。