软件工程——团队作业3

一.团队成员
组长

杨然    1500802102

组员

沈奇    1500802098
汪浩    1500802117
应静    1500802108
韩英璨  1500802104
赵慧玲  1500802107

二.编码规范

HTML代码规范

1.代码风格
1.1缩进与换行
[建议]使用4个空格作为一个缩进层级。
[建议]模板代码的缩进优先保证 HTML 代码的缩进规则。

1.2命名规则
[强制]class：必须单词全字母小写，单词间以-分隔，且必须代表相应的模块或部件的内容或功能，不得以html内置样式进行命名，命名应该具有明确的语义。
[强制]id：必须保持在页面中的唯一性，命名应该具有明确的语义。

1.3标签
[强制]Html中的标签名必须使用小写字母。
[强制]标签的闭合要符合html5的规定。
[强制]标签的使用必须符合标签的嵌套规则，例：div不得置于p中，tbody必须置于table中。
[建议]标签的使用必须遵循标签的语义,例如：
p - 段落
h1,h2,h3,h4,h5,h6 - 层级标题
strong,em - 强调
ins - 插入
del - 删除
abbr - 缩写
code - 代码标识
cite - 引述来源作品的标题
q - 引用
blockquote - 一段或长篇引用
ul - 无序列表
ol - 有序列表
dl,dt,dd - 定义列表
[建议]在CSS可以实现相同需求的情况下不得使用表格进行布局。

1.4属性

[强制]属性必须使用小写字母，其属性值必须用双引号包围。
[建议]布尔类型的建议不添加属性值。自定义属性建议以 xxx- 为前缀，推荐使用data-

2.页面头部

2.1 DOCTYPE
[强制]使用doctype 来启用标准模式，建议使用大写的 DOCTYPE

2.2语言编码
[建议]有助于提高页面的可访问性，必须设置正确的lang属性，例：
[强制]页面必须指定字符编码的meta，且必须是 head 的第一个直接子元素，例：。

2.3 CSS和JavaScript引入
[强制]引入css时必须指明rel="stylesheet"，在引入css和javascript时必须指明type属性。
[建议]Javascript代码必须放在页面末尾或采用异步加载。

2.4Head内容
[强制]Title标签必须设置为head的直接子元素，并紧随charset声明之后。
[强制]Favicon保证可访问，例：
[强制]Viewport属性必须指定。

3.图片
[强制]禁止 img 的 src 取值为空，延迟加载的图片也要增加默认的 src属性值。
[建议]重要图片添加 alt 属性值。
[建议]添加 width 和 height 属性以避免页面抖动。

4.表单

4.1控件标题
[强制]文本标题的控件必须使用 label 标签将其与其标题相关联，例：我已确认上述条款或用户：

4.2按钮
[强制]使用 button 元素时必须指明 type 属性值

4.3可访问性
[建议]当使用 JavaScript 进行表单提交时，应使原生提交功能正常工作。
[建议] 根据内容类型指定输入框的 type 属性，例：

5.多媒体
[建议]使用 audio 以及 video 标签来播放音频、视频时，应当注意格式：
音频格式：MP3、WAV、Ogg
视频格式：MP4、WebM、Ogg

6.注释
[强制]针对页面或模块的CSS、javascript代码必须进行详细的注释

PHP代码规范

命名约定
1.类：
(1)使用大写字母作为词的分割，其他的字母均使用小写；
(2)名字的首字母使用大写;
(3)不要使用下划线('_')；
如：Name、SuperMan、BigClassObject。

2.函数：
(1)函数名只包含字母数字的字符，数字是允许的但大多数情况下不鼓励；
(2)函数名总是以小写开头，当函数名包含多个单词，在首单词后的所有单词首字母大写，以“驼峰”格式来处理；
(3)函数名应当说明函数的意图和行为。

3.变量：
(1)变量名只包含字母数字的字符，数字是允许的但大多数情况下不鼓励；
(2)变量名总是以小写开头，当变量名包含多个单词，在首单词后的所有单词首字母大写，以“驼峰”格式来处理

4.常量：
(1)常量包含数字字母字符和下划线，数字允许作为常量名;
(2)常量名的所有字母必须大写;
(3)常量中的单词必须以下划线分隔

字符串
当字符串是文字(不包含变量)，应当用单引号来括起来
当文字字符串包含单引号就用双引号括起来，特别在 SQL 语句中有用

字符串连接
字符串必需用 "." 操作符连接，在它的前后加上空格以提高可读性

数组
索引不能为负数，建议数组索引从0开始。
当用 array 函数声明有索引的数组，在每个逗号的后面间隔空格以提高可读性
可以用 "array" 声明多行有索引的数组，在每个连续行的开头要用空格填补对齐
当用声明关联数组，array 我们鼓励把代码分成多行，在每个连续行的开头用空格填补来对齐键和值

类的声明
花括号应当从类名下一行开始。
每个类必须有一个符合PHPDocumentor标准的文档块。
类中所有代码必需用四个空格的缩进。

类成员变量
变量的声明必须在类的顶部，在方法的上方声明。
不允许使用 var ，要用 private、 protected 或 public。直接访问 public 变量是允许的但不鼓励，最好使用访问器（set/get）。

函数和方法声明
在类中的函数必须用 private、 protected 或 public 声明它们的可见性。
像类一样，花括号从函数名的下一行开始。
函数名和括参数的圆括号中间没有空格。
强烈反对使用全局函数。

函数和方法的用法
函数的参数应当用逗号和紧接着的空格分开
带有数组参数的函数，函数的调用可包括 "array" 提示并可以分成多行来提高可读性，同时，书写数组的标准仍然适用

控制语句
if/else/elseif 使用 if and elseif 的控制语句在条件语句的圆括号前后都必须有一个空格。在圆括号里的条件语句，操作符必须用空格分开，鼓励使用多重圆括号以提高在复杂的条件中划分逻辑组合。
前花括号必须和条件语句在同一行，后花括号单独在最后一行，其中的内容用四个空格缩进。

switch
在 "switch" 结构里的控制语句在条件语句的圆括号前后必须都有一个单个的空格。 "switch" 里的代码必须有四个空格缩进，在"case"里的代码再缩进四个空格。

注释
每个类必须至少包含这些phpDocumentor标签
每个函数，包括对象方法，必须
有最少包含下列内容的文档块（docblock）：
函数的描述
所有参数
所有可能的返回值
因为访问级已经通过 "public"、 "private" 或 "protected" 声明。

命名规则

头：header

内容：content/containe

尾：footer

姓名：name

账号:id

密码：password

收货地址：address

电话号码：phonenumber

管理员：admin

工作人员：stuff

用户：user

时间：time

用户账号（手机号注册）:user id

订单: order

订单信息（快递短信）: message

工作人员工作号: staffs id

身份证号 : id number

黑名单 : blacklist

三.数据库设计

User:用户
User id:用户账号（手机号注册）
Order:订单
Message:订单信息（快递短信）
Name:姓名
Phone number:手机号
Address:用户收货地址
Staffs:工作人员
Staffs id:工作人员工作号
Id number:身份证号
Password:密码
Blacklist:黑名单