软件工程第五次团队作业--可乐

此博客为团队作业

1.成员介绍:

项目分析代码实现:张洋洋,张淇淞
代码规范:翟平,徐淑娜
博客园:赵金辉 董美地
选题展示内容:孔祥菲,李超
选题讲解:赵东旭,徐逗

2.团队照片:

3.团队队长:张洋洋

4.代码规范:

1. 程序块缩进
程序块要采用缩进风格编写,缩进的空格数为4个。
2.程序块之间空行
相对独立的程序块之间、变量说明之后必须加空行。
3.长语句和长表达式
较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
4.循环、判断等长表达式或语句
循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
5.长参数
若方法或过程中的参数较长,则要进行适当的划分。
6.短语句
不允许把多个短语句写在一行中,即一行只写一条语句。
7.条件、循环语句
if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
8.语句对齐
对齐只使用空格键,不使用TAB键。
9.方法、过程和结构等语句块
方法或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。
10.程序块分界符
程序块的分界符应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在方法体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
11.有效注释量
一般情况下,源程序有效注释量必须在20%以上。
12.方法头部说明
方法头部应进行注释,列出:方法的目的/功能、输入参数、输出参数、返回值、调用关系等。
13.注释与代码一致
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
14.注释内容
注释的内容要清楚、明了,含义准确,防止注释二义性。
15.注释缩写
避免在注释中使用缩写。(说明:在使用缩写时或之前,应对缩写进行必要的说明。)
16.注释位置
注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
17.变量、常量注释
对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量的注释应放在其上方相邻位置或右方。
18.数据结构的注释
数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。
19.全局变量
全局变量要有较详细的注释,包括对其功能、取值范围、哪些方法或过程存取它以及存取时注意事项等的说明。
20.注释缩排
注释与所描述内容进行同样的缩排。
21.注释与代码之间空行
将注释与其上面的代码用空行隔开。
22.变量定义、分支语句
对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
23.避免在一行代码或表达式的中间插入注释。
24.通过对方法或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。
25.在代码的功能、意图层次上进行注释,提供有用、额外的信息。
26.在程序块的结束行右方加注释标记,以表明某程序块的结束。
27.注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。
28.标识符命名清晰
标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
29.特殊命名需注释
命名中若使用特殊约定或缩写,则要有注释说明。
30.标识符命名风格保持一致
自己特有的命名风格,要自始至终保持一致,不可来回变化。
31.变量命名
对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
32.命名规范与系统风格一致
命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊标识如标识成员变量或全局变量的m_和g_,其后加上大小写混排的方式是允许的。
33.除非必要,不要用数字或较奇怪的字符来定义标识符。
34.在同一软件产品内,应规划好接口部分标识符(变量、结构、方法及常量)的命名,防止编译、链接时产生冲突。
35.用正确的反义词组命名具有互斥意义的变量或相反动作的方法等。
36.除了编译开关/头文件等特殊应用,应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。
37.运算符优先级
注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
38.避免直接使用数字作为标识符
避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。
39.源程序中关系较为紧密的代码应尽可能相邻。
40.不要使用难懂的技巧性很高的语句,除非很有必要时。
41.公共变量
去掉没必要的公共变量。
42.公共变量说明
仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
43.公共变量赋值
当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。
44.防止局部变量与公共变量同名。
45.严禁使用未经初始化的变量作为右值。
46.防止多个模块共用公共变量
构造仅有一个模块或方法可以修改、创建,而其余有关模块或方法只访问的公共变量,防止多个不同模块或方法都可以修改、创建同一公共变量的现象。
47.数据类型
使用严格形式定义的、可移植的数据类型,尽量不要使用与具体硬件或软件环境关系密切的变量。
49.不同结构间的关系不要过于复杂,不要设计面面俱到、非常灵活的数据结构。
50.结构中元素的个数应适中
若结构中元素个数过多可考虑依据某种原则把元素组成不同的子结构,以减少原结构中元素的个数。
51.结构中元素布局和排列
仔细设计结构中元素的布局与排列顺序,使结构容易理解、节省占用空间,并减少引起误用现象。
52.编程时,要注意数据类型的强制转换,尽量减少没有必要的数据类型默认转换与强制转换。
53.对所调用方法的错误返回码要仔细、全面地处理。
54.明确方法功能,精确(而不是近似)地实现方法设计。
55.局部变量
编写可重入方法时,应注意局部变量的使用。
56.接口方法参数
在同一项目组应明确规定对接口方法参数的合法性检查应由方法的调用者负责还是由接口方法本身负责,缺省是由方法调用者负责。
57.方法的规模尽量限制在200行以内,一个方法仅完成一件功能。
58.为简单功能编写方法。
59.尽量不要编写依赖于其他方法内部实现的方法。
60.避免设计多参数方法,不使用的参数从接口中去掉。
61.避免使用无意义或含义不清的动词为方法命名。
62.对于提供了返回值的方法,在引用时最好使用其返回值。

5.最喜欢的模式:

一: 交响乐团模式。该模式的优点是各司其职,分工明确,并重在执行,当某个软件领域处于稳定成长阶段的时候,众多大型软件公司的开发团队就会采取这种模式。但这种模式分工过于明确,不适合刚刚起步的公司,有局限性。

二:功能团队模式。该模式就是具备不停能力的同事们平等协作,小组内交流比较频繁,共同完成一个功能。但该模式下,各个角色之间没有管理和被管理的关系,并且保证不了每个小组和其他小组编程规范达成一致。

猜你喜欢

转载自www.cnblogs.com/Jinitaimeia/p/11764815.html