tpcrm规范

tpcrm项目后台相关规范性说明(请务必严格遵守)


一、文件命名、变量命名统一采用驼峰命名方式。

例:
crmTp.php
$crmTp='xxxxx';

二、关键点必须写清楚注释

三、每个文件采用 UTF-8 无BOM头,避免开发过程的报错

四、大括号{}、if和switch

1、首括号与关键词同行,尾括号与关键字同列;

2、if 结构中,else 和 elseif 与前后两个大括号同行,左右各一个空格。另外,即便 if 后只有一行语句,仍然需要加入大括号,以保证结构清晰;

3、switch 结构中,通常当一个 case 块处理后,将跳过之后的 case 块处理,因此大多数情况下需要添加 break。break 的位置视程序逻辑,与 case 同在一行,或新起一行均可,但同一 switch 体中,break 的位置格式应当保持一致。

以下是符合上述规范的例子:

tpcrm规范_第1张图片

五、运算符、小括号、空格、关键词和函数

每个运算符与两边参与运算的值或表达式中间要有一个空格;

左括号“(” 应和函数关键词紧贴在一起,除此以外应当使用空格将“(”同前面内容分开;

右括号“)”除后面是“)”,其他一律用空格隔开它们;

除字符串中特意需要,一般情况下,在程序以及HTML中不出现两个连续的空格;

任何情况下,PHP程序中不能出现空白的带有TAB或空格的行,即:这类空白行应当不包含任何TAB或空格。同时,任何程序行尾也不能出现多余的TAB或空格;

每段较大的程序体,上、下应当加入空白行,两个程序块之间只使用1个空行,禁止使用多行。

程序块划分尽量合理,过大或者过小的分割都会影响他人对代码的阅读和理解。一般可以以较大函数定义、逻辑结构、功能结构来进行划分。少于15行的程序块,可不加上下空白行;

说明或显示部分中,内容如含有中文、数字、英文单词混杂,应当在数字或者英文单词的前后加入空格。

根据上述原则,以下举例说明正确的书写格式:


3、每个文件,头部都需要书写:文件名,描述,作者,时间,修改时间,修改人,修改内容信息(请直接复制以下信息)
例:

新建文件时

/*

*

*

* @file_name: get_game_open.php

*

* @desc: 计划任务执行打开游戏数据(redis)写入mysql操作

*

* @author: cooper

*

* @date: 2015.07.21

*

* @change_date:

*

* @change_author:

*

* @change_content:

*

*

*/

修改文件时

/*

*

*

* @file_name: get_game_open.php

*

* @desc: 计划任务执行打开游戏数据(redis)写入mysql操作

*

* @author: cooper

*

* @date: 2015.07.21

*

* @change_date: 2015.07.22

*

* @change_author: cooper

*

* @change_content:

* 1、对相关内容进行优化,减少执行时间。

* 2、删除广告对应设备号入库部分代码,直接查询open表就可以。

*

*

*/

你可能感兴趣的:(tpcrm规范)