Documentation
README
Java 编码规范
将这个 skill 视为 Java 17+ / Spring Boot 项目的简明工作卡。SKILL.md 只保留流程和路由,具体规则按需加载 references/ 下的参考文件。
使用原则
- 仓库内规则优先于本 skill。若
AGENTS.md、CLAUDE.md、本地格式化配置或相邻代码与本 skill 冲突,优先遵循仓库约定;只有当冲突会影响结果时,再明确指出。 - 不要为了满足本 skill 而大规模重构无关代码。优先贴近现有模式,除非当前实现已经带来真实的正确性、安全性、事务或可维护性风险。
- 规则要尽量具体、可检查。维护本 skill 时,始终追问一句:删掉这条后,AI 是否更容易犯真实错误?
- 禁止项要配上推荐替代方案。例如:不要用字段注入;优先使用构造器注入,通常配合 Lombok
@RequiredArgsConstructor。 - 机械性规则尽量交给工具。优先依赖 formatter、Checkstyle、Spotless、测试、CI 或 hooks,不要只靠自然语言约束格式。
工作流程
编写或重构代码时
This is the opening of the README. Read the full README on GitHub.