一、编码规范和编码原则
命名规范
(1) 方法命名:我们使用完整的英文描述,首字母小写,每个英文单词的首字母大写,其余字母小写,属性存取是使用setX、getX,返回布尔类型值的方法是使用isX,例如下列命名方式: queryStaffById、isCodeExists()、getValue;
(2) 属性命名:使用完整的英文描述,首字母小写,每个英文单词的首字母大写,其余字母小写, 确保我们的属性名和方法名绝不重复;
(3) 常量命名:我们所有单词的首字母都是大写并用“_”分隔。
(4) 组件命名:都是以组件类型结果,如:StaffService、OrgService;
(5) 数据库命名:
表:“模块名_表名”,
字段:bool类型用“Is”、“Can”、“Has”等表示;日期类型命名必须包含“Date”;时间类型必 须包含“Time”。
存储过程:使用“proc_”前缀。
视图:使用“view_”前缀。
触发器:使用“trig_”前缀。
(6) 属性和方法的命名一般不超过15个字母;
(7) 将媒体查询放在相关规则的附近。我们没有将他们打包放在一个单一样式文件中或者放在文档底部。
(8) 所有声明语句都是以分号结尾。最后一条声明语句后面的分号虽是可选的,但是,如果省略这个分号,代码可能更易出错,所以我们统一不省略。
(9) 我们不在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。这样利于从多个属性值(既加逗号也加空格)中区分多个颜色值(只加逗号,不加空格)。
(10) 为选择器中的属性添加双引号,例如,input[type="text"]。只有在某些情况下是可选的,但是,为了代码的一致性,我们都加上了双引号。
(11) 我们避免了为 0 值指定单位,例如,用 margin: 0; 代替 margin: 0px;
(12) 对于以逗号分隔的属性值,我们每个逗号后面都插入了一个空格(例如,box-shadow)。
(13) 我们的CSS颜色是用小写,而且全部是用缩写,例如#fff;。
(14) 各种运算符的规范:
(1) 逗号、分号只在后面加空格。
(2) 比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。
(3) "!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。
(4) "->"、"."前后不加空格。
(5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。
(15) 我们的CSS声明顺序遵循以下要求:
1.Positioning 位置属性,比如position / top / right / bottom / left / float / display / overflow等。
2.Box model 盒模型属性,比如border / margin / padding / width / height 等。
3.Typographic 文字相关属性,比如font / line-height / text-align / word-wrap等。
注释规范
(1) 函数内部(模块内部)注释:
每行十行代码都存在注释,注释放置在语句的上方或右侧;注释与备注是语句同缩进;注释与上面的代码用一个空行隔开,对if/switch/case/while/do while 添加了注释;修改代码也加上了注释;注释内容明确,而且使用了易理解的词语。
(2) 函数外部(或者是模块间)注释:
对每个模块都进行了注释,如包、文件、类、接口、类属性、方法注释等等。
(3) 代码中的单行或者多行注释:
// 这是单行注释
/*这是多行注释*/
(4) 对于较长的注释,务必书写完整的句子;对于一般性注解,可以书写简洁的短语。
排版规范
(1) 程序块采用缩进4个空格位,不采用TAB,避免了不同编辑器对TAB处理不同。
(2) "{"、" }" 独占一行,位于同一列。
(3) 较长的语句、表达式、参数书写了多行。
(4) 一行只写了一条语句。
(5) 选择语句、循环语句、分支语句的关键词如if ……else/switch/do……while等等,都是独占一行。
(6) 相对独立的业务语句块之间,变量说明后会加上空行。
(7) 类属性和方法没有交叉放置,不同存取范围的属性或方法也没有远交叉放置。
二、数组库设计
三、项目E-R图
四、功能流程
①用户选择自己的喜好。
②根据用户设置的喜好从后台菜品数据中查询符合用户喜好的菜品。
③将推荐的菜品与商品提供给用户,用户可以选择根据推荐在附近餐厅就餐或者是根据推荐的原料和烹饪过程自己动手烹饪。
④当用户对推荐菜谱不感兴趣的的时候也可以点击查看每日推荐中随机推荐的菜品。
五、分工
沈凤岐 |
主要负责微信小程序项目管理 |
陈朗 |
主要负责小程序开发 |
苏鹏飞 |
主要负责数据收集 |
党虎飞 |
主要负责视频制作 |
六、贡献分
本组一共四个人员,总共40分
团队人员 |
贡献分 |
沈凤岐 |
10分 |
陈朗 |
10分 |
苏鹏飞 |
10分 |
党虎飞 |
10分 |