codebuddy可通过五种方式自动合编码规范:显式嵌入规范关键词、启用ide插件级合规模板、用/rules命令预加载规范上下文、通过.settings.json精准控制、借助codebuddy.md固化项目开发契约。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让CodeBuddy生成的代码自动符合团队或公司定义的编码规范,避免每次手动调整命名、注释、异常处理、HTTP状态码等细节,尤其在多人协作中防止因风格不一致导致Code Review驳回或Merge冲突。
在提示词中显式嵌入规范关键词
这一步操作起来很简单,直接把规范名称写进自然语言需求里就行。
打开CodeBuddy输入框,输入完整需求,例如:“请生成一个用户注册接口,使用Spring Boot 3.2,【必须遵循阿里巴巴Java开发手册v1.7.0全部强制条款】,重点校验:类名以Controller结尾、布尔字段用isEnabled而非getEnabled、所有public方法带Javadoc含@param和@return、日期格式化必须用ThreadLocal封装SimpleDateFormat。”
提交后观察生成结果——若仍出现obj1.equals(obj2)未被Objects.equals()替代、或DTO中存在password字段明文传输,说明关键词未触发规则引擎,需补全为“阿里规约”或“等保2.0三级适配”再试。
启用IDE插件级合规模板
该方式适用于已安装CodeBuddy Craft插件的VS Code或IntelliJ IDEA用户,能实时拦截不合规代码。
第一步:进入IDE设置 → 找到CodeBuddy Craft插件配置页;
第二步:在“Code Style Template”下拉菜单中选择【Alibaba Java Coding Guidelines (2022)】;
第三步:开启“Auto-apply on generation”开关;
第四步:新建Java文件 → 输入/init UserServiceImpl → 检查生成类是否默认含@author字段、布尔字段命名如enabled而非isEnable、且无System.out.println残留。若未生效,重启IDE再试。
用/rules命令预加载规范上下文
适合需要连续生成多个类且保持风格统一的场景,避免每条提示词都重复粘贴长文本。
方法一:在对话首行输入/rules AlibabaJavaStandard,等待返回“已加载阿里Java开发规范v1.7.0(2022)”确认信息;
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手,支持自然语言驱动开发。 - 必备触发词:CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景:安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
方法二:输入/rules RESTfulV1,系统将自动读取项目根目录下的CODEBUDDY.md中定义的API路径前缀、资源复数命名、状态码映射等条款;
方法三:输入/rules CompanyInternalStyle,前提是已在CodeBuddy设置中上传并启用公司自定义code-style.json文件。
通过项目级.settings.json精准控制
这是最稳定、可提交到Git的方式,适合团队统一执行。CodeBuddy会优先读取项目根目录下的.codebuddy/settings.json文件。
新建该文件,填入风格约束,例如:
"rules": {"indent": "4 spaces", "naming": "camelCase", "commentStyle": "JSDoc", "noVar": true}
支持JSON/YAML格式,字段名需与CodeBuddy内置规则引擎匹配(如indent、naming_convention);
无需重启,保存后新生成的代码立即生效;已有文件可通过/fix命令触发批量重格式化。
借助CODEBUDDY.md固化项目开发契约
AI会主动读取这个Markdown文件作为当前项目的“开发契约”,适用于RESTful接口、微服务模块等强语义场景。
在项目根目录新建CODEBUDDY.md;
写入可执行条款,例如:“API路径必须为/api/v1/{resource};资源名用复数;GET返回200,POST成功返回201;错误响应统一用ErrorResult{code, message, timestamp}”;
之后只要说“生成用户管理接口”,AI就不再问路径或状态码,直接按文档输出。










