「效率工具」飞码规则文件:让AI成为更懂你的企业专属开发助手!

76 阅读4分钟

汉得企业级智能编码助手(中文名飞码,英文名H-AI Coder,以下简称飞码), 结合AI智能驱动与H-ZERO专属规则驱动,支持智能代码补全、代码对话问答、智能代码诊断、 知识问答、高质量H-ZERO相关脚手架代码生成等场景,同时支持企业级权限管控及可视化分析。旨在提供更加规范、高效的开发体验,提升用户开发效率与代码质量。

本文聚焦飞码规则文件功能,助力大模型化身你的企业专属工程师,精准掌控对话生成内容,让代码更规范、更贴合业务,真正理解你的“企业语言”。

什么是飞码规则文件?

飞码规则文件是您与飞码智能编码助手进行高效沟通的蓝图。通过编写高质量的规则文件,您可以将企业开发规范、常用组件用法、最佳实践与潜在陷阱精确传递给 AI,帮助其生成可信赖、合规范、高质量的企业级代码。

1. 全局规则:组织统一规范

  • 生效范围: 全局自动生效

  • 设置路径: File → Settings → Tools → HZERO Copilot → Chat Completions

  • 适用场景: 统一代码风格、团队协作规范、全局技术偏好(如禁用某些语法)

  • 提示: 谨慎修改,影响所有项目

2. 项目规则:项目统一规范

  • 生效范围: 当前项目自动生效

  • 存储路径: 项目根目录下.hzero-copilot/project-rules/*.md

  • 适用场景: 指定技术栈(如Spring Boot + Mybatis)、项目目录规范、依赖包版本约定。

  • 示例: 定义DTO命名规范、日志输出格式、异常处理方式等

3. 会话规则:手工选择上下文

  • 生效范围: 单次会话手工选择添加生效

  • 扫描路径:

  • 适用场景: 注入组件说明(如H-ZERO权限组件)、API文档、当前模块上下文。

  • 操作方式: 对话时点击“+”或输入“@”选择规则文件

如何使用飞码规则文件?

使用飞码规则文件,只需简单三步:

1. 创建规则文件

编写 Markdown 格式的飞码规则文件。您可以参考《飞码规则文件编写实用指南》获取完整指导,也可直接复用 H-ZERO 平台团队提供的核心组件最佳实践

2. 按需存放

根据实际场景需求,将规则文件放置在对应目录,即可覆盖全局、项目或会话范围。

3. 触发AI对话

在对话中自动或手动应用规则文件,让 AI 按照规范生成更贴合业务的高质量代码。

核心场景示例

场景一:项目层统一规范 - DDD 代码规范

下图展示了如何在项目层配置基于 H-ZERO 开发规范 的领域驱动设计(DDD)规则文件,该规则文件可帮助团队统一项目代码结构、明确业务模块职责边界、减少重复代码,并提升协作效率。

随后发起 AI 对话,系统可以自动生成目标实体的增删改查(CRUD)代码,大幅提升开发效率。

最终生成的代码不仅严格遵循项目层设定的DDD 代码结构,还兼顾了 H-ZERO 开发规范 的要求,从而确保代码既符合领域设计,又符合企业标准化开发流程。

场景二:开发组件最佳实践 - Redis 消息队列

当需要让 AI 理解某个组件的领域知识时,可以在会话中按需添加对应的规则文件。例如,下图展示了如何配置 Redis 消息队列 的规则文件,用于指导 AI 理解组件的使用方式和约束。

通过在对话中指定这些规则,AI 将能够准确理解组件的功能和用法,并在生成代码或提供操作建议时,严格遵循这些规则,从而保证输出符合项目或系统的实际业务需求。

最终对话生成的业务代码如下:

结语

借助飞码规则文件,AI 将深度契合企业开发流程,生成一致、可维护、合乎业务规范的代码,真正化身为你的企业专属工程师。 💬 欢迎在评论区留言,一起探讨智能编程在您业务中的应用潜力~

联系我们

  • 如果您想了解飞码更详细的功能介绍和产品信息,可以查阅我们的产品文档 请在PC端打开 ➡️汉得焱牛开放平台【文档>技术产品>汉得H-AI飞码智能编码助手】

  • 相关产品咨询或更多信息了解,欢迎联系我们 邮箱 ➡️ openhand@vip.hand-china.com

  • 试用飞码期间,若您有任何问题需要咨询,都可前往焱牛开放平台(open.hand-china.com)提反馈,或将疑问发往联系邮箱。我们有专业人员针对您的问题进行解决回复,技术精良的研发团队根据您的反馈进行应用优化。期待您的反馈,我们将用心对待每一份回应~