gpt4 book ai didi

基于php编程规范(详解)

转载 作者:qq735679552 更新时间:2022-09-28 22:32:09 24 4
gpt4 key购买 nike

CFSDN坚持开源创造价值,我们致力于搭建一个资源共享平台,让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章基于php编程规范(详解)由作者收集整理,如果你对这篇文章有兴趣,记得点赞哟.

今天写这个是为了 提醒自己 编程过程 不仅要有逻辑 思想 还有要规范 代码 这样可读性 。

1、PHP 编程规范与编码习惯最主要的有以下几点:

 1 文件说明 。

 2 function 函数体说明 。

 3 代码缩进 。

 4 if省略 。

 5 变量规范 。

 6 命名规范 。

 7 十行一注释 。

 8 注释风格 。

 9 开放关闭原则 。

2、文件说明 个人代码 -规范如下:

?
1
2
3
4
5
6
7
8
9
10
11
<?
/*
  +----------------------------------------------------------------------
  + Title    : 标题
  + Author    : 作者
  + Version   : 版本号
  + Initial-Time : 这个文件初始创建的时间
  + Last-time  : 这个文件最后修改的时间 + 修改人的名称
  + Desc     : 这个文件的简单描述
  +----------------------------------------------------------------------
*/

3、Function 函数体说明:

?
1
2
3
4
5
6
7
8
9
10
11
12
<?
/**
  * 函数体简单的描述
  * @author_start : 作者
  * @author_end  : 修改时间 + 修改者
  * @param string : $id    描述
  * @param array : $array 描述
  * @param array : $num  描述
  * @return : 返回值说明
*/
function Test($id, $array = array(), $num = 1){
}

注意:Function里面变量参数的代码缩进风格 。

4、代码缩进:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?
$str = 1;
$info = '123';
$version = '123123';
$name = 'test';
$i  = 'haha';
 
# 一般在最外部的if 或流程控制语句都应该上下留空一行
if ($info) {
 
}
 
# 一般在最外部的for或者 foreach都应该上下留空一行
for ($i=0 ,$i<6 ,$i++){
 
}

5、IF省略 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
<?
# 一般在if语句与其分支的流程控制语句当中,存在这exit或者return的情况下,都应该省略其else的部分操作
# 错误
if () {
   return false;
} else {
   return true;
}
# 正确
if () {
   return false;
}
return true;

6、变量规范,使用英文命名 。

?
1
2
3
4
5
6
7
8
9
<?
# 正确
$title = '标题';
$name = '名称';
$pwd  = '密码';
# 错误
$biaoti = '标题';
$ming  = '名称';
$mima  = '密码';

7、命名规范 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?
/**
  * 实际开发中,命名方式一般有三种情况
  * 注意:不管是类名,变量,方法名,在实际开发中,最多只能是不超过3个单词的组合
  * 大驼峰 :每个单词首字母大写
  * 小驼峰 :中间单词首字母大写
  * 蛇形  :每个单词小写,单词与单词之间使用 _ 符合链接
  */
 
# 大驼峰,常用于类名定义
class Car{}
class BlueCar{}
 
# 小驼峰,常用于方法名定义
class Car{
  public function getColor(){}
}
 
# 蛇形,常用于变量名定义
$res_id  = 1;
$res_name = 2;

9、注释风格 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?
1、当需要对某段代码,做大量描述时,使用以下注释风格
/**
  * 我是说明
  * ① 流程一
  * ② 流程二
  * ③ 流程三
  */
 
2、当需要对一行代码,做小量描述时,使用以下注释风格
# 这是XXXX给ZZZZ的变量,叫CCCC
$name = '';
 
3、当需要对一行代码,做简介描述时,使用以下注释风格
$name    = ''; // X表的字段
$index_head = ''; // 首页请求头

10、开放关闭原则 。

实际上这是一个概念,是设计模式中的一种.

简单来说,就是一个已经完成上线的class或者api,可以在不改动起原文件的情况下,对其功能进行外部扩展.

以上这篇基于php编程规范(详解)就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持我.

原文链接:http://www.cnblogs.com/china90/archive/2017/08/16/7376520.html 。

最后此篇关于基于php编程规范(详解)的文章就讲到这里了,如果你想了解更多关于基于php编程规范(详解)的内容请搜索CFSDN的文章或继续浏览相关文章,希望大家以后支持我的博客! 。

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com