通义灵码支持项目专属规则(Project Rules)的设定, 这些规则存储在 .lingma/rules
目录下,仅对当前工程生效。通过设定项目专属规则,可以帮助模型更精准地理解并适应您的编码偏好,例如理解项目框架和代码风格等。
点击查看灵码规则库,获取系统提示词的最佳实践。
前提条件
如需使用该功能 ,需要开发者将通义灵码更新至以下版本,或者下载 Lingma IDE ,如需更新请前往下载和安装:
JetBrains 插件:更新至 v2.1.5 及以上。
VS Code 插件:更新至 v2.5.16 及以上。
Visual Studio 插件:更新至 v0.4.4 及以上。
Lingma IDE:已下载并安装。
规则限制
单个规则文件最大限制为 10000 字符,超过部分将自动截断。
规则文件请使用自然语言描述,不支持图片或链接的解析。
规则同步
规则文件存储在项目目录中,可以随项目代码一同通过Git等版本控制工具进行团队间的共享和同步。
如果希望规则仅对个人本地环境生效,可以将.lingma/rules目录添加到项目的.gitignore文件中。
规则设置和使用
在不同的IDE中,其配置界面的入口和操作方式略有差异。下面为您分别介绍如何在VS Code、JetBrains、Visual Studio和Lingma IDE中设置和使用项目专属规则。
当规则和记忆存在冲突时,将优先遵循规则执行。
VS Code
JetBrains、Visual Studio、Lingma IDE
最佳实践
为了帮助通义灵码有效地遵守您的规则,规则文件编写请遵循以下做法:
保持简洁明确:保持规则简洁、明确、具体。过长或含糊不清的规则可能会让通义灵码感到困惑。
结构化表达:使用项目符号、编号列表和 Markdown 格式来格式化您的规则。与长段落相比,这些格式更易于通义灵码理解。
提供示例:在规则中提供“好的代码示例”(Do),这能极大地帮助模型理解您的意图。
迭代优化:创建规则后,通过实际的代码生成和问答来测试其效果,并根据模型的反馈不断迭代和优化您的规则描述。
点击查看灵码规则库,获取系统提示词的最佳实践。