Clean Code

1. 关于代码

1. 遵循后台/前端框架的项目结构，文件放到该放的文件夹里面。
2. 文件的命名：全部小写，名字表达出功能。
3. 函数、变量命名：名字表达出功能，禁止使用看不懂的名字。
4. 代码注释：通过函数名、变量名能一眼看出功能的，无须写注释；含复杂逻辑的，一定写注释。
5. 代码重构：相同逻辑的代码块出现多次，建议重构成函数。类似功能的代码，放在一起。
6. 接口返回模型：坚持使用统一的接口返回格式，便于异常处理。

2. 关于Git

1. 阅读完Pro Git的重点章节后，再使用Git。
2. 本项目规模很小，无需使用分支开发模式。
3. git commit中的message应当简介地描述出所作的改动，禁止直接在github上上传/改动文件而不写入任何message。
4. git push前先git pull。
5. 每次提交的内容应当只针对一个功能的添加/改动，不建议一次性提交包含多个功能点修改的内容。
6. 只要合理地使用git，不用担心项目改动后出现的bug，因为可以回退。
7. 如果实在不熟悉git的使用，建议下载GitHub Desktop。
8. git的速度太慢或连接不上：科学上网是最佳途径。

Author: 冯旭

Create Time: 2022-02-19

Update Time: 2022-02-19