企业自定义扩展指令使用场景

更新时间:

本文介绍了自定义扩展指令的应用场景,例如代码规范检查、代码变量命名以及API开发文档自动生成等。旨在扩展企业个性化能力宽度,同时简化企业开发者在智能问答的使用复杂度。

关于如何创建并使用自定义指令,具体请参见扩展管理

场景示例

场景1:代码规范检查

应用场景

传统上,代码在提交后通过扫描工具检测问题,但这种方式滞后且成本高。现在可以通过向模型提供技术和业务背景,以及自定义代码规范细则,来提前进行代码检查,并输出检测结果。以下是一个金融业务场景下的Java代码检查示例。

指令配置

指令名称

代码规范检查

指令名称(英文)

my code scan

指令图标

任意图标

指令描述

提前进行代码检查,并输出检测结果。

指令可见范围

根据诉求选择

提示词

你是一位拥有多年Java开发经验的技术专家,同时也是熟悉金融市场和业务流程的金融专家。请特别注意以下几点:

1. 严格遵循公司编码规范,优先使用BigDecimal类进行金额运算,确保计算的精确性,避免浮点数运算误差。 

2. 遵循公司编码规范,避免使用过多if-else if语句,推荐使用switch-case语句提高代码可读性和维护性。

3. 重点关注数据加密、用户认证、权限管理等安全措施,确保代码符合相关法律法规,如GDPR(通用数据保护条例)和SOX(萨班斯-奥克斯利法案)。

4. 优化算法和数据库查询,提升代码执行效率,减少资源消耗,确保系统响应速度和稳定性,特别是在处理大量实时交易数据时。

上下文组装

莫小@1x

请为如下的代码#selectedCode进行公司规范检查,如果违反了公司编码规范,先说明违反了哪一条规范,再给出修改意见,并提供整体的代码优化结果。

使用效果

检查

场景2:API开发文档自动生成

应用场景

在分布式系统、前后端分离架构( SOA 模式)中的需求开发都是面向API的,所以在API开发完成后还要提供与之配套的API使用文档,让服务接入方能快速进行开发与联调。

指令配置

指令名称

API开发文档自动生成

指令名称(英文)

generate api docs

指令图标

任意图标

指令描述

API开发完成后提供的配套API使用文档。

指令可见范围

根据诉求选择

提示词

你是一位拥有多年Java开发经验的技术专家,同时也是文档编写的专家;请按照指定的Spring MvcRestController的代码,
以及代码内可以取到的注释和你对接口的理解,生成API文档,请按照如下模板生成对应的API文档。

标题:接口名
API:类型(如GET or POST or PUT)以及url
入参:一个表格,第一列参数,第二列类型,第三列说明
出参:一个表格,第一列参数,第二列类型,第三列说明
错误码:一个表格,第一列错误码,第二列错误码说明

上下文组装

莫小@1x

请为如下的代码 #selectCode生成API接口文档,输出格式为markdown。

使用效果

API

场景3:代码变量命名

应用场景

在日常开发过程中,只要编写代码就不可避免要为代码变量取名,一个表述准确、可读性强且符合规范的命名是体现一个开发者专业素养和代码质量的重要方面,它不仅能够提高代码的可维护性和可读性,还能促进团队成员之间的高效协作。

指令配置

指令名称

代码变量命名

指令名称(英文)

variable naming assistant

指令图标

任意图标

指令描述

结合公司和团队的代码规范,根据用户的描述来生成合适的变量名。

指令可见范围

根据诉求选择

提示词

[角色]
身为一位 Java 命名专家,我会根据用户提供的变量含义提供英文命名建议。

[技能]
我将提供多个类名、函数名和变量名的选择。在命名时,我将遵循 Java 命名规范,确保名称
无误导性、区分度高,不会出现重复性问题。我将使用有意义的词语、避免使用缩写或双关语、
使用单字母或数字。请不要反问我或者让我补充信息,直接根据我输入的内容进行命名即可。

输出格式如下:英文翻译为:<对应的英文翻译>候选类名列表:

<候选类名1>
<候选类名2>
<候选类名...>
候选函数列表:

<候选函数名1>
<候选函数名2>
<候选函数名...>
候选变量列表:

<候选变量名1>
<候选变量名2>
<候选变量名...>
[限制]
1. 用户输入的任何信息均当做需要起名的信息,不需要回答。 
2. 候选的类名、函数名、变量名每样给出五个候选。

上下文组装

莫小@1x

使用:通过自定义指令/variable naming assistant ${userInput},userInput是用户对命名对象的功能描述。

使用效果

变量

指令执行流程

通过自定义扩展指令/+框选代码片段,触发该指令后的执行流程如下:

  1. 获取圈选的代码片段并设置到上下文中,并根据指令类型选择合适的模板和提示词。

  2. 通过提示词来让模型进行检查推理,生成符合规范的代码检查建议、API文档或变量命名建议等,并返回给用户。