团队作业2：需求分析&原型设计

结对成员：曾海明（组长）：201421122036                       周雅静（组员）：201421122003                        王珏（组员）：201421122057

              于波（组员）：201421122058                          叶赐红（组员）：201421122045                        蓝朝浩（组员）：201421122048

一、需求分析（NABCD）

项目的流程主要按照 NABCD 模型展开。

1、N（Need 需求）

　　现在网路发达的时代，通过博客、社区等学习平台进行自主学习的方式受到广大群众的青睐，博客是一个很优秀的学习交流平台。

2、A（Approach 做法）

　　后台：添加模块和文章和用户管理等。前台：用户登录注册、文章搜索和评论。

3、B（Benefit 好处）

　　提供一个用户学习和交流的博客平台，用户可以发帖和评论，还有热门文章供用户阅读，用户可以在平台学习相应模块知识和发布相应模块的文章。

4、C（Competitors 竞争）

　　现在的学习交流平台层出不穷，而且功能也很完善，已被广大用户所熟知。该平台从功能和知名度上都充满竞争和挑战。

5、D（Delivery 推广）

　　当前在完善过程中，短期推广对象为周围老师、同学，预期达到周围老师、同学的认同，且方便使用的功能。

二、原型设计

 1、首页基础布局

2、登陆/注册 页面展示

3、文章详情

三、编码规范

3.1.1      标签

<?php ?>或<?= ?>界定 PHP 代码，在HTML页面中嵌入纯变量时，可以使用<?= ?>这样的形式，不可使用其他的标签变种。

3.1.2      注释

1)         单行注释：在语句结尾用双反斜杠”// “注释

2)         多行注释：多行注视以”/*”或“/**”符号开头，以”*/ “符号作为注释结束符。

3.2      命名规则

Pascal命名法：所有单词第一个字母大写，其他字母小写。 

Camel命名法(驼峰命名法) ：除了第一个单词，所有单词第一个字母大写，其他字母小写。 

采用英文单词或其组合，便于记忆和阅读，切忌使用汉语拼音来命名。 

3.2.1       文件

1)         类文件的名称和类名一致,如类HelloWorld，相应的文件名为HelloWorld.php

2)         配置文件名小写，如 config.php

3)         嵌套php的view文件使用Camel命名法，第一个字母小写，其他单词的第一个字母大写。如：addApp.php

3.2.2 类

类命名采用Pascal命名方法，类名应该和文件名相匹配。

3.2.3      函数/方法

通常方法一般为一个动作或行为动词，函数/方法的命名采用Camel命名方法

 function run() 

function runFast() 

function getBackground()       

尽量用有意义，描述性的词语来命名  

用checkForErrors()代替errorCheck()，用dumpDataToFile()代替dataFile()。  

有时前缀名是有用的：   

is - 含义为问一个关于某样事物的问题。无论何时，当人们看到is就会知道这是一个问题。   

get - 含义为取得一个数值。  

set - 含义为设定一个数值  

例如：isHitRetryLimit 

内部成员函数命名应该是以 “_”开始：

function _isUserTicket ();  

3.2.4        变量名

1)         用有意义的，描述性的词语来命名变量  

2)         别用缩写。用name, address, salary等代替 nam, addr, sal   全局变量以”g_” 开头 

3)         别使用单个字母的变量象i, n, x 等. 使用 index, temp等 ，用于循环迭代的变量例外： for ($i = 0; $i < count; $i++) {   ... }

 

3.2.5       常量名

量全部使用大写字母和下滑线组成,常量的名称中不允许出现小写字母，可使用分隔符作为下划线。

3.3    书写规则

3.3.1        文件

1)         所有的PHP文件必须使用Unix LF(换行)作为行结束符。

2)         所有PHP文件必须以一个空行结束。

3)         纯PHP代码的文件关闭标签?>必须省略

3.3.2      行

1)         行长度不可有硬限制。

2)         行实际长度不应超过80个字符；较长的行应当被拆分成多个不超过80个字符的后续行。

3)         空行可以用来改善可读性和区分相关的代码块。

4)         一行不应多于一个语句。

3.3.2        缩进

每个缩进的单位约定是4个空格的缩进，并且不可使用制表符作为缩进，需每个参与项目的开发人员在编辑器(Eclipse、EditPlus、Zend Studio等)中进行强制设定将TAB转化为4个空格，以防在编写代码时遗忘而造成格式上的不规范。

3.3.4        控制结构

对于控制结构的样式规则概括如下：

1)         控制结构关键词之后必须有一个空格

2)         左括号之后不可有空格

3)         右括号之前不可有空格

4)         在右括号和左花括号之间必须有一个空格

5)         代码主体必须有一次缩进

6)         右花括号必须主体的下一行

每个结构的主体必须被括在花括号里。这结构看上去更标准化，并且当加新行的时候可以减少引入错误的可能性。