面向对象及软件工程—

一、代码规范

代码规范可以分成两个部分：

a、 代码风格规范

主要是文字上的规定，看似表面文章，实际上非常重要。

b、 代码设计规范

牵涉到程序设计、模块之间的联系、设计模式等方方面面的通用原则。

1.代码风格

代码风格的原则是：简明，易读，无二异性。

1.1缩进

4个空格的距离从可读性来说刚刚好

1.2行宽

现代行宽限定为100字符

1.3括号

在复杂的条件表达式中，用括号表示逻辑优先级

1.4断行与空白的{}行

如：if(condition){

　　　　DoSomething();

　　}

　　else{

　　　　DoSomethingElse();

　　}

1.5分行

不要把多条语句放在一行

1.6命名

在变量名中不提到类型或其他语法方面的描述
避免过多的描述
如果信息可以从上下文中得到，那么此类信息不必写在变量名中
避免可要可不要的修饰词

1.7下划线

用来分隔变量名字中的作用域标注和变量的语义

1.8大小写

由多个单词组成的变量名用大小写区分

1.9注释

1. 注释要简单明了

2. 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

3. 在必要的地方注释，注释量要适中。注释的内容要清楚，明了，含义准确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。

4. 对代码的注释应放在其上方相邻位置，不可放在下面。

5. 对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；同一结构中不同域的注释要对齐。

6. 变量、常量的注释应放在其上方相邻位置或右方。

7. 全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

2.代码实际规范

2.1函数

最重要的一条原则就是：只做一件事，并且要做好

3.代码复审

代码复审的目的在于：

找出代码的错误(编码错误和不符合团队代码规范的地方)
发现逻辑错误
发现算法错误
发现潜在的错误和回归性错误
发现可能需要改进的地方
教育或者互相教育开发人员，传授经验，让更多的成员熟悉项目各部分的代码

二、数据库设计

三、 ER图

四、主要功能流程描述

五、分工及贡献分

分工	姓名	贡献分
代码规范	冶青俊	10.2
数据库设计	韩晓忠	10.0
ER图	余金炜	10.0
功能流程	陈宁宁	9.8

转载于:https://www.cnblogs.com/alwaysni/p/10960634.html