一套适用于Claude Code及类似工具(Augment、Cursor等)的全局代码架构提示词,助力提升代码质量与维护效率:
• 硬性指标:
- Python、JavaScript、TypeScript等动态语言单文件 ≤ 200行
- Java、Go、Rust等静态语言单文件 ≤ 250行
- 每层目录文件数 ≤ 8个,超出需细分子目录
• 避免代码「坏味道」:
- 僵化(Rigidity):改动引发连锁修改,降低灵活性
- 冗余(Redundancy):重复代码导致维护困难
- 循环依赖(Circular Dependency):模块间死结,难以解耦
- 脆弱性(Fragility):局部修改引发全局故障
- 晦涩性(Obscurity):代码难懂,阻碍团队协作
- 数据泥团(Data Clump):参数多且常一起出现,应封装为对象
- 不必要的复杂性(Needless Complexity):过度设计导致臃肿
• HTML 文件特别提醒:
- 遵循“分离关注点”原则,CSS和JS需与HTML结构分离
- 单文件行数尽量 ≤ 500行,功能过多时拆分为可复用组件
• 实践要求:
- 编写、阅读、审核代码时,严格遵守硬性指标,持续关注架构优雅度
- 识别「坏味道」时,主动询问用户是否优化并给出合理建议
这套提示词不仅规范了代码规模与结构,更深层挖掘了架构设计的本质痛点,具备长期参考价值,助力团队构建高质量、易维护的代码库。
详情🔗 x.com/wquguru/status/1951936322538447198
代码架构 软件工程 代码质量 开发规范 ClaudeCode