软件工程-团队作业3
一、代码规范及编码原则
-
(一) 代码原则是:简明,易读,无二义性。
- 缩进,4个空格,在VS2005和其他的一些编辑工具中都可以定义Tab键扩展成为几个空格键。不用 Tab键的理由是Tab键在不同的情况下会显示不同的长度。4个空格的距离从可读性来说正好。
- 行宽必须限制,但是以前有些文档规定的80字符行宽太小了(以前的计算机/打字机显示行宽为80字符),现在时代不同了,可为100字符。
- 括号在复杂的条件表达式中,用括号清楚地表示逻辑优先级
- 代码简单:不隐藏设计者的意图,抽象干净利落,控制语句直截了当。
- 没有重复:重复代码意味着某些概念或想法没有在代码中良好的体现,及时重构消除重复。
- 分层明确:代码分层清晰,隔离明确,减少间接依赖,划清名空间,理清目录。
(二) 编码规范
- 变量、常量、函数名等的声明位置和命名规范
- 分号的位置和使用(哪些地方必须使用分号)
- 空格、空行、换行的注意点
- 函数的使用注意事项
- 数组、对象的定义规范、书写格式等
- 当有多层嵌套时,每一层嵌套都要有完整的{ }。
(三) 注释规范
- 注释规范主要是对我们所编写代码的注释时机(哪些位置需要注释,哪些情况下需要注释)、注释格式进行约束。
- 格式如: (注意注释符和注释内容之间的空格)
注释快捷键:Ctrl+/
注释行:选中某一行 Ctrl+/ 要与你要注释的代码缩进相同
注释一段代码:选中某一段代码 Ctrl+/
(四) 命名规范
-
变量及名称开头必须是以下字符中的其中一个:
字母:a-z或者A-Z中其中一个,例如:var a1 a1:function(){}
下划线:_,例如:var_a1 _a1:function(){}
美元符号:$,例如:var$a1 _a1:function(){}
- 根据变量(函数)的功能与用途对其进行命名
- 变量名(函数名)开头使用小写字母
- 使用驼峰命名法命名(适用于变量名中包含多个单词)
- 全局变量使用全大写命名(优点:提高代码可读性)
- 变量名(函数名)中不要出现空格
- 变量名首个字符不能为数字
- 函数名首个字符不能为数字或直接用数字命名
- 命名应该有意义,尽量不要使用缩写,除非一看就明白或特别长的单词。
- 变量名称不能随意,会降低代码可读性。
(五) 标点规范
- JS语句无需以分号结束,统一省略分号
- JS中一致使用反引号 ``或单引号' ' , 不使用双引号。
- WXML、WXSS、JSON中均应使用双引号。
- WXSS属性中冒号中后面用一个空格分隔开。
- 执行一致的缩进(4个空格)
- 执行一致的换行样式('unix')
(六) 代码风格
- 花括号“{}”不允许省略,即使只有一段代码。
- 不允许省略访问修饰符。
- 类型默认是密封的。
- 不允许公开字段。
- 使用括号“()”来强调运算符优先级。
- 一行语句的字符数不能太长,一般不超过80个字符,多出的应该换行显 示。
- 代码缩进,统一缩进四个空格,不要使用软件自带的Tab键,因为每个 软 件的Tab键的缩进可能会不一致,如果需要使用,应将软件的Tab键设置为四个空格。
二、汽车销售E-R图
三、主要功能流程描述
(1)用户进入小程序首页可以浏览最新的车型品牌,点击不同类型的车型可以查看关于此车的全部信息。
(2)点击首页会有不同的选项,比如商家推荐等,它会给买车党提供广大群众比较满意的车型;也可点击二手专卖,已达到用户和商家的二手车的交易。
(3)客服可以对我们的售车服务进行评价留言,用户的建议是我们不断前进的动力。
(4)“我们”这个功能则主要以文字的形式会向客户展示我们这个团队的一些项目背景等。
(5)“商城”则会显示最近火热促销的一些车型,可使用户了解到关于车型的最新社会动态。
(6)此外还有购物车功能,此功能可以说为用户提供了极其便捷的服务,当用户遇到喜欢的车,就可快速加入购物车,最后在进行对比从而选择自己最嘱意的爱车。
(7)“个人中心”功能不言而喻就是为用户全面设计的,此功能主要用于储存用户的信息,为用户及时查看及其设置自己的一些服务及其功能提供了方便。
四、团队分工
队员: 分工: 贡献分:
汪桂青 团队项目E-R图 10分
吴春秀 代码规范及编码原则 10分
张文杰 主要功能流程描述 10分
王淑青 主要功能流程描述 10分