企业代码库生成增强
通义灵码提供了基于企业代码库进行代码生成增强的能力,在开发者使用通义灵码 IDE 插件的智能代码生成时,可以结合企业上传的代码库作为上下文进行行间代码补全,代码补全更加贴合企业代码规范、业务特点。
适用版本 | 通义灵码企业专属版 |
通义灵码管理员、组织内全局管理员可以在通义灵码管理控制台中进行代码库文件添加或删除、开启或关闭检索增强功能。
企业代码库管理
上传代码库压缩包
通义灵码管理员、组织内全局管理员可以进行企业代码库的管理,上传步骤:
单击侧边导航知识管理,单击添加数据按钮,即刻进入添加数据页面;
选择数据类型为:代码,单击或拖拽代码库压缩包到上传区域(灰色区域)即可上传知识库文档,上传文件时需要注意以下要求:
一次上传 1 个代码库压缩包;
文件格式支持:zip、gzip、tar.gz;
单个文件大小不超过 100MB;
文件名称不得超过 200 个字符。
上传完成后,单击确认添加即可添加成功,相关代码库会进入数据处理流程。
代码知识库不建议以业务库作为知识库内容,建议以常用的二方包源码、工具库等作为知识库以提升行间生成补全质量。
开启行间代码生成检索增强
知识管理-代码分类下,如果有代码库压缩包完成数据处理,即可开启行间代码生成检索增强的开关。
开启后,已授权的开发者在 IDE 客户端中使用通义灵码行间代码智能生成的功能时,将结合上传的代码数据进行代码建议生成。
场景示例
通常情况下,前端团队会维护一套统一的编码规范,以便团队中前端工程师参考和遵循。例如,在使用 ReactJS 开发时,通常会有清晰的 bad case / good case 定义,确保 Props 的编写既清晰又高效,避免潜在的不良编码习惯。
import React from 'react'
type Props = {
children:react.reactnode;
}
// bad
const lndex = (props: Props)=> {
return <>{props.children}</>
}
// bad
const Index<Props>=({ children }) => {
return <>{children}</>
}
// good
const Index: React.FC<Props> = (props) => {
return <>{props.children}</>
}
这种情况下,可以通过通义灵码的代码库生成增强达成,操作步骤如下:
通义灵码管理员在管理后台中,上传符合编码规范的代码仓库压缩包,例如:Ant Design:作为 UI 设计的典范,遵循严格的 React 组件设计规范;
开启行间代码生成检索增强;
团队中前端工程师在 IDE 端中安装并开启通义灵码插件;
前端工程师在代码编辑器中进行编码时,通义灵码可以遵循上传的代码库的中的编码规范进行代码建议生成,如下图:
查看代码的数据处理进展
代码库压缩包上传后,系统将对数据进行向量持久化处理,以将代码处理成可以供检索增强的格式,并且可在代码库列表中查看数据处理的进展。文档处理的状态分别为:
等待处理:系统将有序对上传的文件进行处理,未开始处理的进入排队状态;
处理中:正在对文件进行分析和向量化处理;
已完成:该文档已完成分析并向量持久化;
异常:文档处理出现异常,聚焦在状态标记上可查看原因,此时可结合不同的情况进行重新处理或删除异常文件;
重复文件:文件内容重复,不进行重复处理,可删除重复文件;
更新代码库
如果代码库有更新,可直接通过添加数据的操作上传新的文档,上传后将进行重新处理。
删除代码库
处理异常、重复、或不再需要的代码库,可单击删除操作进行单个代码库的删除。如需批量删除,可在列表中勾选后进行批量删除。