引言
在当今快速发展的技术领域,AI 编码辅助工具正逐渐成为开发者的得力助手。这些工具通过学习和预测开发者的编码习惯,提供代码补全建议,极大地提高了编码效率。然而,为了最大化这些工具的潜力,开发者需要了解和应用一些最佳实践。
一、 AI 代码助手简介
AI代码助手是一款集成到主流IDE中的智能编程辅助工具,这款工具基于混元大模型,提供技术对话、代码补全、代码诊断和优化等能力,旨在帮助开发者生成优质代码,解决技术难题,提升编码效率
AI代码助手在代码补全方面的核心能力主要体现在两个方面:
1. FIM技术(Fill In the Middle):通过将代码分割成前缀、中间和后缀三部分,打乱前缀和后缀的顺序,让模型预测中间部分,从而增强模型对代码逻辑的理解和补全能力。这种方法特别适用于处理代码的连续性和逻辑性,确保补全的代码不仅符合当前上下文,而且能够准确预测后续逻辑。
2. 跨文件理解能力:助手能够整合当前文件、打开的文件、引用依赖以及项目内其他文件中的代码信息,以提供更全面的代码补全建议。通过分析代码的目录结构、依赖程度和信息相似性,模型能够更准确地匹配和排序相关代码片段,从而在补全时提供更准确的代码选项。
这些技术使得AI代码助手在代码补全方面更加精准,能够更好地理解和预测开发者的意图,提供高质量的代码建议。
二、代码补全优秀实践场景
在代码补全场景中,代码可以被看作是一种特殊的prompt,用于引导 AI 代码助手生成高质量的代码提示。当开发者有目的地编写代码时,实际上是在为 AI 代码助手提供清晰的意图上下文。下面是一些比较优秀的代码补全实践:
提供示例,补充编码意图
直接在 html 中补全一个对象,AI 代码助手无法直接根据对象渲染出 Dom,或者生成的 Dom 随机性很高。我们可以先给一个示例,然后根据示例渲染对象。
给出 info 中 name 的 dom 结构之后,AI 代码助手根据 name 的结构补全了剩下的属性
增加上下文,给出代码业务方向
在一些具体的业务场景中,可能会由于上下文过少,导致模型难以准确的推导后续代码,这是补全时给出的代码不是研发想要的。比如下面这个业务,上下文只是简单的定义了是否存在打卡记录,没有具体的业务逻辑,这种情况下,生成的代码就会很随机。
这个时候,我们给出一段示例,systolicPressure 是用来计算和获取心脏收缩压的相关状态。这种情况下,模型就会理解用户的编码意图,生成后续心脏舒张压、心率等状态的代码。
使用前缀保持命名一致性,绑定属性
有联系的模块之间,使其拥有相同的前缀或者后缀,保持命名的一致性,能有效的控制代码生产的准确率和有效性,提高开发效率
如下图所示:将属性 Desc 修改成 jhdataDesc 之后,渲染出来的 DOM 和 jhdata 属性进行了绑定
使用语义化的方法名补全方法
通过语义化的方法名协助 AI 明确开发者意图和目的,让 AI 提供更合理的补全函数内容
vscodeApi
dayjs Api
检查表单
有较高相识度的胶水代码
在程序员编码过程中,存在大量的胶水代码,比如 常见的 CURD、异常处理(比如 Go 中常见的 if err != nil 以及前端常见 toast&message)、日志打印等,这些代码都是 AI 非常擅长生成,并且准确率很高的部分。
工具或通用算法类逻辑代码
一些工具逻辑的场景,比如排序、过滤等,AI 也可以准确、快速的生成对应代码
在意图明确且简单,但是代码相对复杂的场景
在一些在意图明确且简单,但是代码相对复杂的场景,提效最明显,比如优先从 redis 获取缓存的项目信息,如果未命中缓存则从 DB 中查询。
提升 AI 生成代码的技巧总结
AI 代码助手并非万能的,不同的编码习惯和书写顺序也可能导致补全效果有差异,提升 AI 补全能力的具体方法涉及到多个方面,以确保 AI 代码助手能够更准确地理解开发者的意图、预测开发者的编码内容,以下是一些技巧总结:
具体的示例:通过提供示例代码和详细注释,明确表达编码意图,帮助模型识别开发者期望的输出格式和内容,减少模型的不确定性。
丰富上下文信息:增加代码的上下文信息,包括业务逻辑和流程,帮助 AI 理解代码的业务方向,从而提供更符合业务需求的补全。
遵循编码规范和语义化命名:规范化的编码习惯使 AI 更容易预测行为和输出。语义化的命名则能够明确表达代码的意图,消除歧义,使得代码在整体上下文中更易于理解。
规范注释的使用:详细的注释为 AI 提供了额外的上下文信息,有助于解释代码的意图和目的。这对于理解复杂逻辑至关重要,可以显著提升 AI 补全代码的准确率。
利用相似代码片段:打开与当前任务相似的代码片段,特别是对于通用的“胶水代码”,帮助 AI 快速识别并补全这些常见的代码模式。
通用逻辑代码:对于工具类或算法类代码,提供通用的逻辑框架和算法描述,使 AI 能够理解并补全这些代码,是在意图明确但实现复杂的场景中尤为有效。