智一科技 约定 php

一.目的：
1.提高开发团队的协助能力；
2.提高程序代码的可读性和可重复利用性；
3.开发团队根据自己的实际情况，可以对本规范进行补充或裁减；

二.整体要求：
1.参照PEAR的规范；
2.在PEAR基础上增加、修改或删除部分适合具体开发环境的规范；
3.本规范包含了PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则；

三.命名：

1. 变量

1) 普通变量
a． 所有字母都使用小写；
b． 对于一个变量使用多个单词的，使用’_'作为每个词的间隔；

例如：$base_dir、$red_rose_price

2) 静态变量
a． 静态变量使用小写的s_开头；
b． 静态变量所有字母都使用小写；
c． 多个单词组成的变量名使用’_'作为每个词的间隔；
例子：$s_base_dir、$s_red_rose_prise

3) 局部变量
a． 所有字母使用小写；
b． 变量使用’_'开头；
c． 多个单词组成的局部变量名使用’_'作为每个词间的间隔。
例子：$_base_dir、$_red_rose_price

4) 全局变量
全局变量应该带前缀’g',知道一个变量的作用域是非常重要的。
例如：
global $gLOG_LEVEL;
global $gLOG_PATH;

5) 全局常量
全局变量命名遵循以下规则：
a． 所有字母使用大写
b． 全局变量多个单词间使用’_'作为间隔。
例子：$BASE_DIR、$RED_ROSE_PRICE等。

6) session变量
session变量命名遵循以下规则：
a． 所有字母使用大写；
b． session变量名使用’S_’开头；
c． 多个单词间使用’_'间隔。
例子：$S_BASE_DIR、$S_RED_ROSE_PRICE等。

2. 类命名

a． 以大写字母开头；
b． 多个单词组成的变量名，单词之间不用间隔，各个单词首字母大写。
例子：class MyClass 或class DbOracle等。

3  方法或函数
a． 首字母小写；
b． 多个单词间不使用间隔，除第一个单词外，其他单词首字母大写。
例子：function myFunction ()或function myDbOracle ()等。

4  缩写词
当变量名或者其他命名中遇到缩写词时，参照具体的命名规则，而不采用缩写词原来的全部大写的方式。
例子：function myPear（不是myPEAR） functio getHtmlSource（不是getHTMLSource）。

5 PHP 数据库表名
1) ．表名均使用小写字母；
2) ．对于视图，使用_v开头；
3)． 对于多个单词组成的表名，使用_间隔；

6 PHP 数据库字段
1) ．全部使用小写；
2) ．多个单词间使用_间隔。
例子：user_name、rose_price等。

 

四.注释：

/**
* name: Database
* description: 数据库操作类
* author: wuzekai
* date: 2019-4-02
*/
class Database {
    ......
}

/** 
* 获取一行记录
* method Name: getOne()
* param: string $query_str SQL查询字符串 
* param: string $username 用户名
* return: mixed 查询返回值（结果集对象） 
*/ 
function getOne（$query_str,$username）{
    ……
}

//数据库连接用户名 
var db_user_name;

 

转载于:https://www.cnblogs.com/wuzekai/p/10670270.html