通义灵码企业代码补全增强使用实践

本文涉及的产品
性能测试 PTS,5000VUM额度
可观测监控 Prometheus 版,每月50GB免费额度
注册配置 MSE Nacos/ZooKeeper,118元/月
简介: 通义灵码提供了企业代码补全增强的能⼒,在开发者使⽤通义灵码 IDE 插件的⾏间代码补全时,可以结合企业上传的代码库作为上下⽂进⾏⾏间代码补全,使代码补全更加贴合企业代码规范、业务特点。本⽂将分享如何构建⾼质量的企业代码库,以及开发者在前端和后端开发场景的使⽤实践。

作者:任婷婷(汐遥)


通义灵码提供了企业代码补全增强的能⼒,在开发者使⽤通义灵码 IDE 插件的⾏间代码补全时,可以结合企业上传的代码库作为上下⽂进⾏⾏间代码补全,使代码补全更加贴合企业代码规范、业务特点。本⽂将分享如何构建⾼质量的企业代码库,以及开发者在前端和后端开发场景的使⽤实践。


管理员如何准备高质量企业代码库


为确保代码数据的有效处理,我们建议您遵循以下指导原则来准备代码库。这将有助于提升检索的效率与准确性。


准备指南

1. 上传限制仅适⽤于源代码⽂件,代码库中应仅上传实际编写的源代码⽂件。例如,对于 Java 应上传 .java ⽂件,对于 C# 应上传 .cs ⽂件,对于 JavaScript 应上传 .js 或 .jsx ⽂件等。


2. 请避免上传以下内容。

  • 测试数据与代码:请勿上传测试脚本、测试⽤例或任何不包含业务逻辑的测试相关代码。
  • Mock ⽅法:排除所有由模拟⽅法和⼯具⽣成的代码,除非这些代码包含对业务逻辑的具体实现。
  • 构建产物:
  • 前端:排除通过构建⼯具(如 Webpack、Gulp 等)⽣成的⽂件,这些⽂件通常位于 dist 或 build ⽬录下。
  • 后端:排除编译⽣成的 DLL ⽂件及其他所有编译输出。


3. 注释要求如下。

  • 对希望被检索到的函数,在函数头部应添加详尽的注释。
  • 注释应提供充分的信息以区分不同的函数,建议参考注释模板或根据企业规范进⾏相应调整。


/**
* 更新指定订单状态。
*
* @param orderId 订单的唯⼀标识符。
* @param newStatus 新的订单状态。
* @return boolean 表示更新是否成功。
*/


4. 函数名称规范要求。

  • 如果函数注释较为简单,则函数名称必须能够准确描述其功能。
  • 使⽤清晰且具描述性的命名⽅式,例如:exportOrdersToPDF、updateOrderStatus ⽽不是 func1 。


上传指南

  • 打包压缩⽂件:将代码⽂件打包为 .zip、.gz 或 .tar.gz 格式。
  • 代码包⼤⼩限制:每个代码包的⼤⼩不得超过 100 MB。


开发者如何使用企业代码生成增强


插件版本要求

仅适⽤于 VSCode 1.3.9 及以上版本,以及 JetBrains 1.3.10 及以上版本。


后端场景使用实践

1. 通过⾃然语⾔注释⽣成代码。


步骤一:企业代码库代码上传

上传包含所需功能代码的压缩包⾄企业代码库,例如雪花算法的代码,并确保⽬标函数遵循注释规范,注释位于函数头部。更详细代码库准备指南请参⻅上述管理员如何准备⾼质量代码库。


/**
* 使⽤雪花算法⽣成唯⼀序列号
* @param workerId
* @return
*/
public synchronized Long getSnowFlowerId(long workerId){
long id = -1L;
if (workerId < 0 || workerId > snowFlowerProperties.getMaxWorkerId()) {
throw new IllegalArgumentException(
String.valueOf("workerID must gte 0 and lte " + snowFlowerProperties.getMaxWorkerId()));
}
// ... 算法实现代码 ...
return id;
}


步骤二:输入注释

在集成开发环境(IDE)中定位到某 Java 类内,输入与期望召回的函数相匹配的注释。注释格式可以灵活,但应确保含义的准确性和⼀致性。


第一种方式


//请通过雪花算法⽣成唯⼀编号的代码,返回⽣成的id


第二种方式


/**
* 使⽤雪花算法⽣成唯⼀序列号
* @param wId
* @return
*/


注释说明:

  • 注释⻓度要求:在编写代码时,注释应尽量避免过于简短,建议⻓度⾄少 15 个字符,过短的注释将无法触发召回。
  • 注释语义要求:确保注释的语义准确且有意义,最好包含关键词与返回值说明,以便通义灵码准确地理解和匹配相应的代码。
  • 多语⾔⽀持:⽀持中英⽂注释,代码库中的注释和实际编码时的注释可以使⽤不同的语⾔。
  • 参数名称灵活性:参数名称可以灵活处理,通义灵码会根据提供的参数⾃动调整以匹配召回的代码。


步骤三:代码⽣成

⾸次回⻋后,灵码将提供基于注释⽣成补全建议;再次回⻋后,灵码将根据企业代码库中的代码进⾏补全。

image.png

说明:

  • 如果您的注释中包含参数,灵码将⾃动调整⽣成代码中的参数名,确保命名⼀致性。
  • 如果需要刷新缓存获取新的补全建议,macOS 可以使⽤ ⌥(option) P ⼿动触发⾏间补全,windows 可以使⽤ Alt P ⼿动触发。


2. 通过函数签名⽣成代码。


步骤一:代码库代码上传

上传包含所需功能代码的压缩包⾄企业代码库,并确保这些函数具有清晰且独特的标识,以便于检索和识别。更详细代码库准备指南请参⻅上述管理员如何准备⾼质量代码库。


步骤二:输入函数签名

在集成开发环境(IDE)中定位到某 Java 类内,键入⽬标函数的签名部分。参数名称可以灵活处理,通义灵码会根据提供的参数⾃动调整以匹配召回的代码。


public List<Object> nextList(String name, int size)


函数签名说明:

  • 函数名称:使⽤较为清晰的函数名称,需要具备⼀定语义作为相似性依据。
  • 参数和返回值:类型和顺序需要与⽬标函数保持⼀致,但参数名称可以灵活处理,通义灵码会根据提供的参数⾃动调整以匹配召回的代码。


步骤三:代码补全

⾸次回⻋后,灵码将提供代码补全建议;再次回⻋后,灵码将根据企业代码库中的代码进⾏⾃动补全。

image.png

说明:

  • 灵码将根据您提供的参数名,⾃动调整⽣成代码中的参数名,确保命名⼀致性。
  • 如果需要刷新缓存获取新的补全建议,macOS 可以使⽤ ⌥(option) P ⼿动触发⾏间补全,windows 可以使⽤ Alt P ⼿动触发。


前端场景使用实践

1. 通过标签补全前端⾃研组件代码。


步骤一:代码库代码上传

在开始之前,您需要确保所有必要的前端组件代码已经上传到企业代码库中。如下是 React 框架示例。


<LTable
isReady={isReady}
formInitialValues={formInitialValues}
rowKey="key"
tableRef={tableRef}
toolbarLeft={
<Button type="primary">新增</Button>
}
formItems={formItems}
formRef={formRef}
columns={columns}
request={async (params, requestType) => {
const res: Record<string, any> = await apiGetUserList(params);
return {
data: res.data,
total: res.total,
};
}}
/>


步骤二:编写组件代码

在您的 IDE 中打开相应的 .jsx ⽂件,并开始编写代码。输入基础 HTML 标签或⾃定义组件标签,例如 <BatchUntagEditor />


步骤三:代码⾃动补全

当您输入的代码达到⼀定⻓度,并且能够与企业组件库中的代码匹配时,IDE 将⾃动触发代码补全功能,为您⽣成完整的组件代码。您也可以通过回⻋,主动触发代码补全。

image.png

重要:请在完整的组件标签内触发您的补全。


2. 通过⾃然语⾔注释⽣成代码。


步骤一:代码库代码上传

上传包含所需功能代码的压缩包⾄企业代码库,并确保每个函数都遵循注释规范,注释位于函数头部。更详细代码库准备指南⻅管理员如何准备⾼质量企业代码库章节。如下是 JavaScript 示例。


/**
* 根据报错信息⽣成,以id为键值的对象
* @param {Array<validator,Result>} results
* @return {Record<string,string>}
*/
function getErrObj(results) {
// ... 函数实现代码 ...
}


步骤二:输入注释

在 IDE 中,在 JavaScript ⽂件内输入特定的注释内容,如下示例。


//根据报错信息⽣成以 id 为键值的对象


注释说明:

  • 注释⻓度要求:在编写代码时,注释应尽量避免过于简短,建议⻓度⾄少 15 个字符,过短的注释将无法触发召回。
  • 注释语义要求:确保注释的语义准确且有意义,最好包含关键词与返回值说明,以便通义灵码准确地理解和匹配相应的代码。
  • 多语⾔⽀持:⽀持中英⽂注释,代码库中的注释和实际编码时的注释可以使⽤不同的语⾔。
  • 参数名称灵活性:参数名称可以灵活处理,通义灵码会根据提供的参数⾃动调整以匹配召回的代码。


步骤三:代码⽣成

⾸次回⻋后,灵码将提供基于注释⽣成补全建议;再次回⻋后,灵码将根据企业代码库中的代码进⾏补全。

image.png


说明:

  • 如果您的注释中包含参数,灵码将⾃动调整⽣成代码中的参数名,确保命名⼀致性。
  • 如果需要刷新缓存获取新的补全建议,macOS 可以使⽤ ⌥(option) P ⼿动触发⾏间补全,windows 可以使⽤ Alt P ⼿动触发。


常见问题:在重新安装插件后,即便重启 IDE 或重新登录,仍无法成功召回知识库中的代码

解决⽅案:

  • 在 macOS 系统中,请执⾏以下命令以重启进程并清除缓存。


ps -ef|grep lingma|grep start|awk '{print $2}'|xargs -I {} kill -9 {}


  • 如果是 Windows 系统,请在进程管理器中结束 Lingma 进程。


推荐阅读:《5 大场景上手通义灵码企业知识库 RAG》


点击此处,立即体验通义灵码企业代码生成增强。

相关实践学习
2分钟自动化部署人生模拟器
本场景将带你借助云效流水线Flow实现人生模拟器小游戏的自动化部署
SVN版本控制系统
SVN是现在软件开发之中的主流软件版本控制工具,在工作之中利用SVN可以有效的解决多人开发的代码管理问题,本课程将为读者讲解SVN服务器的配置以及基于MyEclipse的SVN客户端插件的配置与使用,并且在讲解之中着重讲解了冲突的产生于解决。
相关文章
|
3月前
|
人工智能 自然语言处理
通义灵码在Visual Studio2022中的实践
本文介绍了如何在Visual Studio 2022中安装和使用通义灵码。首先,在Visual Studio 2022中安装通义灵码插件,然后按照步骤完成安装和登录。最后,通过实操演示了通义灵码的三大功能:行级/函数级实时续写、自然语言生成代码和研发领域自由问答。希望读者能从中受益。
1217 4
|
7天前
|
Java 测试技术 开发者
通义灵码助力高效开发——我的实践心得
作为一名Java开发工程师,我一直在寻找提高开发效率的方法。最近,我尝试了通义灵码的个人版新功能,并取得了显著的效果。本文将分享我的实践场景、效果和心得。
35 1
|
17天前
|
大数据 开发者
通义灵码创新实践征集赛获奖名单公布!
通义灵码创新实践征集赛得到了众多开发者的支持和喜爱,现公布活动获奖名单,快来看看吧!
147 5
|
2月前
|
存储 Serverless 数据库
通义灵码与阿里云的融合实践
本文探讨了通义灵码与阿里云的融合实践,涵盖生成在阿里云上部署应用的代码及与阿里云服务的深度集成,如云服务器创建、云数据库配置、云存储设置及函数计算服务等,显著提升开发效率和应用灵活性。
通义灵码与阿里云的融合实践
|
29天前
|
机器学习/深度学习 数据采集 存储
通义千问 Qwen 在智能文本分析中的应用实践
本文探讨了通义千问Qwen在智能文本分析的应用,涵盖文本分类、情感分析及关键信息提取,通过具体案例和代码实现,展示了Qwen的强大语言理解能力,为开发者和研究人员提供了实用参考。
|
30天前
|
人工智能 自然语言处理 小程序
基于通义千问32B及RAG技术的CACA指南诊疗规范平台落地实践
本方案整合CACA智能导航系统与基于RAG的大模型医疗问答系统,旨在提供高效、精准的肿瘤诊治支持。通过指南AI导航、知识图谱查询等功能,优化医生诊疗流程,提升患者服务质量,实现医疗资源的有效利用。
64 6
|
2月前
|
自然语言处理 程序员
通义灵码累计生成超10亿行代码,服务上万家企业!
通义灵码累计生成超10亿行代码,服务上万家企业!
47 6
|
2月前
|
人工智能 移动开发 前端开发
通义灵码使用实践场景、效果和心得。
作为一名H5前端开发学者,我在学习过程中借助通义灵码@workspace大幅提升了效率。通过自动推荐匹配的CSS样式和项目内相似模板的排版建议,减少了重复劳动,效率提高超过一倍。此外,它还能解析并翻译GitHub上的英文.md文件,如成功部署声音合成AI:GPT-SoVITS项目,极大便利了我的学习与开发工作。
81 4
|
2月前
|
人工智能 边缘计算 自然语言处理
DistilQwen2:通义千问大模型的知识蒸馏实践
DistilQwen2 是基于 Qwen2大模型,通过知识蒸馏进行指令遵循效果增强的、参数较小的语言模型。本文将介绍DistilQwen2 的技术原理、效果评测,以及DistilQwen2 在阿里云人工智能平台 PAI 上的使用方法,和在各开源社区的下载使用教程。