代码提交规范
在使用Git进行版本控制时,遵循一定的规范是非常重要的,这有助于保持代码库的整洁和一致性,同时也便于团队协作。
目前最受开发人员肯定的代码提交规范是前端框架`Angular`提出的Angular提交信息规范,继而衍生了 `Conventional Commits specification`。关于提交规范的具体格式,可以参考 [Angular团队提交规范](https://github.co...
Git提交规范
在使用Git进行版本控制时,遵循一定的规范是非常重要的,这有助于保持代码库的整洁和一致性,同时也便于团队协作。
目前最受开发人员肯定的代码提交规范是前端框架`Angular`提出的Angular提交信息规范,继而衍生了 `Conventional Commits specification`。关于提交规范的具体格式,可以参考 [Angular团队提交规范](https://github.co...
commit规范
Commit是Git中用于记录代码更改的基本单元。一个良好的commit应该包含足够的信息,使得其他开发者可以理解更改的目的和内容。
Commit规范的主要目的是确保每次提交都是原子性的、可理解的,并且与项目其他部分的更改无关。这有助于维护清晰的项目历史记录,便于未来的代码审查和问题定位。
- 原子性:每次提交应该只包含一个逻辑上的改变。这使得每个提交都是独立的,并且易于理解和回滚。
...
push规范
Push是Git中用于将本地仓库的更改发送到远程仓库的操作。Push规范确保了代码的同步是有序的、可控的,并且减少了因不同步引起的冲突。
Push规范的主要目的是确保团队成员之间的代码更改能够顺利合并,减少冲突,并保持代码库的一致性。
在执行push操作时,应遵循以下规范:
#### 经常Pull最新的更改
- **保持同步**:在push之前,应该先执行`git pull`或...
commit message规范
Commit message 是开发的日常操作,它可以提供更多的历史信息,方便向团队清晰准确地说明代码变更、进行代码评审,也便于后期快速定位原始需求或缺陷,还可以有效的生成 Change log,对项目的管理实际至关重要,但是实际工作中却常常被大家忽略。
目前,社区有多种 Commit message 的写法规范,但使用较多的是 `Angular` 团队的规范, 继而衍生了`Conventi...
公共风范
公共风格指南包括两层含义,一是各类编程语言,都建议遵守的公共风格,另一层含义指的是代码提交流程。
## 语言风格
比如类命名、函数命名、变量命名、文件命名、缩进、换行、函数长度等等。
公共风格适合大多数语言使用,但也存在个例。
比如,C++和php等语言可以使用4个字符长度的tab作为统一缩进格式,但python则需要空格缩进;
再比如大多数语言都可以使用花括号`{}`来放置函数语句,但...
约定
公共风格指南包括两层含义,一是各类编程语言,都建议遵守的公共风格,另一层含义指的是代码提交流程。
## 语言风格
比如类命名、函数命名、变量命名、文件命名、缩进、换行、函数长度等等。
公共风格适合大多数语言使用,但也存在个例。
比如,C++和php等语言可以使用4个字符长度的tab作为统一缩进格式,但python则需要空格缩进;
再比如大多数语言都可以使用花括号`{}`来放置函数语句,但...
各编程语言都需遵守的约定
公共风格指南包括两层含义,一是各类编程语言,都建议遵守的公共风格,另一层含义指的是代码提交流程。
## 语言风格
比如类命名、函数命名、变量命名、文件命名、缩进、换行、函数长度等等。
公共风格适合大多数语言使用,但也存在个例。
比如,C++和php等语言可以使用4个字符长度的tab作为统一缩进格式,但python则需要空格缩进;
再比如大多数语言都可以使用花括号`{}`来放置函数语句,但...
作用域
最小化是代码风格中比较重要的一条思想,任何改动升级都能通过改动最少的代码达到目的。
编程中,尽量让变量在其最小作用域定义。
===========
那么什么是作用域呢?下文转载了简书快乐舔狗董枭垚的文章来讲解。
作用域是程序中定义的变量所存在的区域,超过该区域变量就不能被访问。
以C 语言为例,有三个地方可以声明变量:
在函数或块内部的局部变量
在所有函数外部的全局变量
在...
命名空间
定义:命名空间将全局作用域细分为不同的具名作用局,可有效防止全局作用局的命名冲突。
优点:命名空间的命名轴线可嵌套。父级命名不同时即使当前命名重复也不会冲突。
结论:合理使用
在编写代码时,应遵循以下命名空间的使用规范:
### 正确写法
- **使用具名命名空间**:定义代码时应使用具名命名空间,而不是将所有代码都放在全局命名空间。
- **嵌套命名空间**:利用命名空间的嵌...
嵌套类
不要将嵌套类定义为public,除非是接口的一部分。
解释:这里是C++代码风格指南中的内容,如果读者朋友是其他语言的开发者,比如php,可以理解为除了接口类或者接口函数,其他函数和类不要定义为public。
- 限制嵌套类的访问权限有助于隐藏类的内部实现细节,减少外部对内部状态的依赖。
- 将嵌套类定义为`private`或`protected`可以鼓励更好的封装和模块化设计。
- ...
全局函数
尽量不要使用全局函数。如果确实需要,那么将该函数封装为类的成员函数。
### 不推荐的写法
```cpp
function readLog() {}
function writeLog() {}
```
### 推荐的写法
```cpp
class Log {
function read() {}
function write() {}
}
```
...