技术规范
# 技术规范
主流编程语言代码规范与 Git 提交规范合集——统一风格,减少低级错误,提升代码可读性。
# 语言覆盖
| 编号 | 规范 | 适用领域 | 参考标准 |
|---|---|---|---|
| 01 | C++ 代码规范 | 系统开发/游戏/嵌入式 | Google C++ Style Guide |
| 02 | Java 代码规范 | 后端/Android/大数据 | 阿里巴巴 Java 开发手册 |
| 03 | JavaScript 代码规范 | 前端/Node.js | Airbnb JS Style Guide |
| 04 | TypeScript 代码规范 | 前端/全栈 | TS 官方 + Airbnb |
| 05 | Python 代码规范 | AI/数据科学/后端 | PEP 8 |
| 06 | Go 代码规范 | 云原生/微服务 | Go 官方 Effective Go |
| 07 | Kotlin 代码规范 | Android/后端 | Kotlin 官方 coding conventions |
| 08 | Swift 代码规范 | iOS/macOS | Swift API Design Guidelines |
| 09 | Rust 代码规范 | 系统编程/WebAssembly | Rust 官方风格指南 |
| 10 | Shell 代码规范 | DevOps/运维脚本 | Google Shell Style Guide |
| 11 | Git 提交规范 | 所有项目 | Conventional Commits |
# 规范核心维度
每份规范涵盖以下维度:
命名 → 变量/函数/类/文件,见名知意
格式 → 缩进/换行/空格,统一风格
注释 → 解释Why不解释What
异常处理 → try-catch规范,不吞异常
并发 → 线程安全、锁的使用
最佳实践 → 行业公认的推荐做法
1
2
3
4
5
6
2
3
4
5
6
# 快速参考
# Git 提交消息格式
<type>(<scope>): <subject>
feat(用户模块): 添加登录功能
fix(支付模块): 修复金额计算精度问题
docs(README): 更新部署文档
1
2
3
4
5
2
3
4
5
# 命名规范速查
| 语言 | 类/接口 | 函数/方法 | 变量 | 常量 |
|---|---|---|---|---|
| Java | PascalCase | camelCase | camelCase | UPPER_SNAKE |
| C++ | PascalCase | camelCase | snake_case | UPPER_SNAKE |
| Python | PascalCase | snake_case | snake_case | UPPER_SNAKE |
| Go | PascalCase | camelCase | camelCase | PascalCase |
| JS/TS | PascalCase | camelCase | camelCase | UPPER_SNAKE |
# 核心原则
- 宁可规范多一点,不可随意写 - 团队统一比个人习惯更重要
- 工具自动化 - ESLint/Prettier/CheckStyle 自动检查,减少人工 Code Review
- 持续更新 - 规范随语言版本和技术演进同步更新
- 新人友好 - 规范是新成员快速融入团队的导航图
- 说清楚 Why - 每条规则都要有理由,不搞"我觉得应该这样"
上次更新: 2026/06/07, 09:51:08