PGuide-Docs/docs/notes/CS-DIY/开发规范/什么是开发规范.md

---
title: 什么是开发规范
createTime: 2025/03/02 20:31:41
permalink: /csdiy/dev-rules/what-dev-rules/
icon: ic:baseline-rule-folder
---
# 什么是开发规范？
无规矩不成方圆，一个优秀的开发团队，必定离不开团队齐心协力规范的制定。

**为什么说它是最重要的？因为：开发不规范，同事两行泪！**

开发规范是每位软件开发者在团队开发中必须遵守的，比如项目代码统一缩进两格、项目圈复杂度不能超过 10 等等。遵守规范有利于提高项目的开发效率、降低维护成本；而如果你不遵守规范，可能会影响到整个团队的开发进度，别人也不乐意和你合作。

## 学习建议
开发规范的学习分为 3 个阶段：

1. 了解开发规范，有人工遵守规范的意识
2. 学会使用工具来帮助自己遵守代码规范，防止人工的疏忽
3. 学会为团队项目定制规范

由于每个团队遵循的开发规范不完全相同，所以千万不要死记硬背规范！

建议大家先简单过一遍大厂团队的代码规范手册（相对标准通用一些），以后做项目的时候只要想到了某个规范，就赶紧去查阅文档确认下。当然也可以直接利用开发工具自带的一些代码检查插件，帮你去纠正一些没注意到的问题。

这里建议大家在前期开发项目时，多观察一些编辑器自动给出的 warning 提示，并且尝试把警告消除。

项目做得多了、慢慢养成习惯后，你会发现遵循规范是一件 “水到渠成” 的事情，不用刻意去记。

而当你成为团队的负责人后，在大家动手做项目前，必须先制定一套开发规范，全场动作才能整齐划一！

## 知识
- 了解开发规范
  - 编码规范
    - 代码风格
    - 变量命名
    - 代码格式
  - 设计规范
    - 开发原则
    - 设计原则
  - 文档规范
    - 文档结构
    - 文档格式
    - 文档内容
- 代码校验工具
  - 通用: Sonar
  - Python: pylint
  - 前端: ESLint
  - C++: clang-tidy
  - Java: CheckStyle
- 制定代码规范

## 资源
- 书籍
  - [《软件工程:实践者的研究方法》](https://book.douban.com/subject/6047742/)（经典大黑书，讲的非常全面，但同样完整读下来还是有些难度的）
  
    [PDF 软件工程:实践者的研究方法(第7版)](https://github.com/QSCTech/zju-icicles/blob/master/%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B/%E6%95%99%E6%9D%90/%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B%EF%BC%9A%E5%AE%9E%E8%B7%B5%E8%80%85%E7%9A%84%E7%A0%94%E7%A9%B6%E6%96%B9%E6%B3%95%EF%BC%88%E7%AC%AC7%E7%89%88%EF%BC%89.pdf)
  - [《软件开发的201个原则》](https://book.douban.com/subject/35628886/)（工具书，看一遍挺好的）
  - [**阿里巴巴Java开发手册**](https://developer.aliyun.com/graph/java)（搜索《Java开发手册》）
  - [**Airbnb JavaScript代码规范**](https://github.com/BingKui/javascript-zh)
- 视频
  - 北京大学软件工程
  @[bilibili](BV1Vt411V72G)
  - 大连工业大学软件工程
  @[bilibili](BV1Ns41177VM)
  - [华山版《Java开发手册》独家讲解](https://developer.aliyun.com/live/1201)
- 大学课件
  - [浙大计算机软件工程](https://github.com/QSCTech/zju-icicles)
- 文档 
  - [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)（谷歌 Java 代码规范）

## **尾语**
**我们要养成开发规范的好习惯这样我们才能输出更加优质的代码~**