Skip to content
This repository was archived by the owner on Mar 12, 2021. It is now read-only.

Commit fe2ec7f

Browse files
committed
Update CodingStandard.md
1 parent 95b2fb4 commit fe2ec7f

1 file changed

Lines changed: 23 additions & 7 deletions

File tree

CodingStandard.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# 代码规范 Beta 2
1+
# 代码规范 Coding Standard
22

3-
by: C.M. 2019.09.20
3+
by: C.M. 2019.10.24
44

55

66

77
## 目录
88

9-
### 第零部分 绪论
9+
### 第零部分 序言
1010

11-
一、 Beta 1 版本绪论
11+
一、 版本日志
1212

1313
### 第一部分 语法规范
1414

@@ -40,13 +40,21 @@ by: C.M. 2019.09.20
4040

4141
三、 框架规范
4242

43+
44+
45+
### 第三部分 技术文档
46+
47+
48+
4349
4450

4551

4652

47-
## 总论
53+
## 序言
54+
55+
### 一、 版本日志
4856

49-
### 一、 Beta 1版本绪论
57+
#### v0.1-beta.1 版本日志 & 绪论
5058

5159
建立完备的编码规则,有助于提高代码的可读性、可维护性、可移植性。代码规范,已经成为具有一定规模的开发团队的必需品。我认为,对于眼下规模的智能车社团,建立一套科学高效、易于遵守的代码规范,可以提高各队之间合作的效率,也便于进行技术交流与传承。基于以上考量,我开始着手制定本代码规范。
5260

@@ -80,14 +88,22 @@ C.M.@hit 2019.09.09
8088

8189

8290

83-
### 二、 Beta 2 版本绪论
91+
#### v0.1-beta.2 版本日志
8492

8593
Beta 1版本的代码规范主要编写的内容是第一部分,随着第一部分即语法规范的完善,其涉及的内容也更加广泛。其中部分内容已经开始涉及一些模式和架构的话题。因此在Beta 1版本的基础上,我开始编写第二部分,这就是Beta 2版本。必须承认,第一部分的内容远远称不上完善,可能存在一些漏洞和问题,也有一些规则值得商榷。在这一版本中,我希望能通过架构规范的不断完善,发现一些潜藏在代码规范中的问题,并加以修复。在架构规范部分,我在制定规范之余,也会根据规范修改完善现有代码,同时不断验证规范的严谨性。
8694

8795
C.M.@hit 2019.09.20
8896

8997

9098

99+
#### v1.0-rc 版本日志
100+
101+
经过近一个半月的总结,这份代码规范终于来到了第一个Release Candidate版本。在这一个半月中,我总结了过去编写代码过程中的经验教训,基础的语法规范已基本完善。随着近期RT1052底层、新K66底层的编写,架构规范也得以完善。在编写过程中,我也接到了一些同学的反馈,做出了一些调整。希望这个版本能对看到它的同学们起到帮助的作用,也希望同学们在实践中提出自己的见解、疑问和建议。
102+
103+
C.M. @hit 2019.10.24
104+
105+
106+
91107

92108

93109
## 第一部分 语法规范

0 commit comments

Comments
 (0)