Code Principles
本技能提供多语言代码规范指导,帮助编写高质量、符合最佳实践的代码。
使用场景
当执行以下任务时参考对应语言的规范:
- 编写新代码 - 创建新函数、类、模块时
- 重构代码 - 改进现有代码结构和质量时
- 代码审查 - 检查代码是否符合规范时
- 添加功能 - 在现有代码基础上扩展功能时
- 修复bug - 修改代码解决问题时
语言规范映射
根据文件扩展名选择对应的规范文件:
| 文件类型 | 参考文档 | 关键原则 |
|---|---|---|
.py |
py-principles.md | 类型安全、现代语法、不可变性、异常处理 |
.rs |
rust-principles.md | 所有权安全、零成本抽象、惯用语法、并发安全 |
.ts, .tsx, .js, .jsx |
ts-principles.md | 类型安全、现代JS/TS、React最佳实践、可访问性 |
核心原则
训练数据会过时。当对框架用法、API 特性或最佳实践存疑时,优先查阅官方文档而非凭记忆决策。
工作流程
- 识别语言 - 根据文件路径确定目标语言
- 读取规范 - 使用 Read 工具读取对应的参考文件
- 应用原则 - 根据规范确保代码满足类型安全、错误处理、命名规范等要求
- 自检 - 完成前检查是否符合该语言的最佳实践
核心检查点
所有语言通用的关注维度:
- 类型注解/签名完整准确
- 错误处理适当(捕获具体异常、不忽略错误)
- 命名清晰,意图明确
- 函数职责单一,复杂度可控
- 无明显的性能或安全问题
框架/库特定代码需参考官方文档,详见各语言文件的「不确定时参考」小节。