微博代码规范

微博代码规范

ID:22299022

大小:187.24 KB

页数:10页

时间:2018-10-28

微博代码规范_第1页
微博代码规范_第2页
微博代码规范_第3页
微博代码规范_第4页
微博代码规范_第5页
资源描述:

《微博代码规范》由会员上传分享,免费在线阅读,更多相关内容在学术论文-天天文库

1、代码编写帮助手册1.目的帮助新同事在最短吋间A了解系统,规范代码风格。为提高代码的执行效率、编写效率、可读性。2.代码框架介绍代码框架(以下简称“框架”)基于曲'向对象的“MVC”模式设计,采用PHP5实现。框架从功能上可以分为6人部分:•框架基于“MVC设计模式“设计,按层次分可以分为数据层、模型层、控制层、现表层。•数据层:完成所有资源操作封装,资源毡括:数据库、内存、文件、接口等。•服务包:以服务接口的方式完成所有资源操作封装,资源包括:数据库、内存、文件、接口等。•模型S:对业务逻辑进行封装,模型S将实现业务相关逻辑•控制层:对输

2、入参数进行类型和宽度检测,问吋将川广请求调川和应业务逻辑。•表现层:本层足请求完成后返冋给川户的结果,棊本上足静态页而为主。代码框架示意图:数据层服务包API后端php工程师1.代码目录介绍MiniblogI——config(存放配置文件,含路径定义,提示信息定义等)Iview(视图层0录)I

3、template(存放模板文件)I

4、languages(存放语言文件)Icontrol(校制SF1录,按功能划分子1"1录)I

5、Controller.php(控制层基类)IImblog(微博内各S录)

6、

7、comment(评论FI录)IIperson

8、(微博用户录)I

9、interface(所食对外接U0隶)II——pub(微博广场R录)I

10、zt(专题门录)I——model(逻辑模型层0录)IImBase.php(横型层基类)IImMblog.php(微博内界类)

11、

12、mCommentBox(评论粮类)I

13、mPerson.php(川广1类)II——...(所宥逻辑模型层类定义)I——data(数据模型层录)I

14、——dBase(存放数据库/数据缓存定义,公井函数等)I

15、dMblog.php(HIP库操作)IIdUser.php(留言库操件:)II——...(所有数据庠操作类)

16、service

17、(服务包)II——base(服务包配S,公共方法)

18、

19、feed(feed服务包)

20、

21、comment(评论服务)I——tools(工具类)代码规范编码格式程序编码使用utf-8程序编码统-•使用utf-8花括号使用花括兮开A标记不换行。空格使用.关键字(如function)和操作符(如”=”)前后耍有空格。(如上个例子)缩进程序类定义顶格,方法和代码块顺序缩进。(如上个例子)命名规范所奋变景名谘不要使川屮文拼音做为变暈名,命名使川常川的英文单词,谘不要使川生辟的英文,方便阅读。变量名和方法名规范♦驼峰式Camel命名法(驼峰命名法):除了第

22、-个单词,所有单词第一个字母人写,其他字母小写。♦需要有意义用checkForErrors()代特eirorCheck(),用dumpDataToFile()代科dataFile()。例如:publicfunctiongetFriendList(){SfriendList=arrayO;常量规范■所存常景都人写,单词问用下划线分割,按照功能不同放在不同的配置文件小,首个单fel为功能的英文■所冇常量都定义在config目录下的配置文件中■代码中所有字符中类型的常量(比如出错信息、成功信息等)和核心系统参数严禁在代码直接使用,必须通过”de

23、fine”才能使用。例如:dcfincCCONST_FRIEND_MAX_COUNT',20);//定义好友的上限全局变量使用规范■所有全局变量都大写,单词间用下划线分割■所奋全局变量都定义在config目录卜'的配S文件小(和常量定义一起)类名规范单同酋字母人写例如:classdBaseprivate$dbconf=’••’;publicfunctionconnectMc($alias,$persistent=true){}}文件和目录规范■文件名规则为“类名”加“.php”■目录名使用小写的英文单词■对于control层和模板文件单独

24、一个功能建立一个鬥录,艽它层程序放在相应R录(对于某功能有多个子类的,nJ以建立子鬥录)方法返回值■任何方法都需要设定返回值,返回值相关说明SYSTEM_ERROR(常量):系统出错,可以根据errNo()和errorMsgO获取错误号和相关错误描述其它:成功注释规范程序注释文件、类和方法注释使川phpdoc统一规范,使川zendstudio吋比较力*好友数据操作类(类功能描述)氺*@packagepower(作川域)*@authorxxx(作者列表、包括修改者)@copyrightsina*/便。例如:classFriend{/***准

25、备杏询某人的好友数据(方法功能描述)**@paraminteger$uid查询人的uid*@paramint$sid查询的资源号*@returnbool*/publicfunctionprep

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。