开发规范
仓库里 .trae/rules/ 下的规则文件是权威来源,本站页面是面向阅读的分发副本。两边冲突时以规则文件与当前代码为准,并按文档同步规则修正本站。
| 规则文件 | 约束内容 | 对应页面 |
|---|---|---|
.trae/rules/comment-style.md | 注释只描述当前行为 | 后端规范 |
.trae/rules/java-no-record.md | 禁用 Java record | 后端规范 |
.trae/rules/no-deprecated-api.md | 禁止过期 API 与旧版依赖 | 后端规范、前端规范 |
.trae/rules/database-readonly.md | 数据库只读 | 后端规范 |
.trae/rules/git-commit-message.md | 提交信息格式 | 提交与代码质量 |
.trae/rules/xxl-job-out-of-scope.md | 上游源码不在工作范围 | 提交与代码质量 |
.trae/rules/deployment.md | 部署入口与容器拓扑(含凭据,不入库、不进文档) | 部署 |
.trae/rules/developer-docs-sync.md | 开发者文档同步 | 文档同步规则 |
通用原则
- 保持技术栈在新版本上:只使用当前版本官方推荐、未标记
@Deprecated的写法;有替代 API 就用替代,不因为「旧的还能跑」而保留。 - 不造兼容层:不引入第三方 fork、polyfill、兼容包,也不用
@SuppressWarnings("deprecation")压告警。 - 改动触及已有的废弃写法就地替换;不在无关改动里顺手大范围重写。
- 逻辑自解释的代码不加注释;注释只解释非显然的业务约束、边界条件与外部协议的特殊要求。
- 新增能力优先复用现有模块,避免引入功能重叠的库。
