`
codejm
  • 浏览: 30397 次
  • 来自: 青岛
社区版块
存档分类
最新评论

PHP 代码规范

    博客分类:
  • php
阅读更多

 

命名规范
 
Θ 类文件都以.class.php为后缀,使用驼峰法命名,并且首字母大写,例如 Pay.class.php;
Θ 类名和目录_文件名一致。例如:类名Zend_Autoloader的目录是Zend/Autoloader.class.php;
Θ 函数的命名使用小写字母和下划线的方式。例如:get_client_ip;
Θ 方法的命名使用驼峰法,首字母小写或者使用下划线"_",例如listComment(),_getResource(),通常下划线开头的方法属于私有方法;
Θ 属性的命名使用驼峰法,首字母小写或者使用下划线"_",如$username,$_instance,通常下划线开头的属性属于私有属性;
Θ 常量以大写字母和下划线"_"命名,如"HOME_URL";
 
 
常用名词
 1>list名词(单数),如listApple,一看我们就知道读取苹果列表,我们没有必要写成getApples或者listApples或readApples——因为get我们规定一般用于读取单个数据,如getApple.listApples不加s我们也知道是取苹果列表(保证尽量缩短变量命名);
 2>get名词(单数);
 3>名词Total,表示某个东西的总数。如expenseTotal;
 4>found:表示某个值是否已经找到;
 5>uccess或ok:一项操作是否成功;
 6>done:某个工程是否完成;
 7>error:是否有错误发生;
 8>result:返回的结果
 
代码重构
 
 1.函数或者方法体内的代码尽量控制在一个屏幕内。
 2.类中不使用的方法随机删除。
 3.修改别人的类中方法,要签名。
 4.在每个模块内写个readme文件(用于比较复杂业务的说明或代码说明)。
 5.尽量让每个类做自己的事,每个函数做一件事。

 

常用代码
 
用&&或||简化操作
 
简化前:
$a=1;
$b = 0;
if(isset($a)){
    $b=1;
    print($b."\n");
}  
 
if($b!=0){
    print($b."\n");
}

简化后:

$a=1;
$b = 0;
isset($a) && ($b=1) && print($b."\n");
$b == 0 || print($b."\n");

 

明显代码看起来更加整齐,更加简单!

 

判断"=="时,我们有可能会把"=="写成"=",这样的bug我们很难调试图来。所以,把常量放在前面,编译器就能判断出来。
 
之前:
$a = 1;
if($a = 1){
    echo '$a == 1';
}

之后:

$a = 1;
if(1 = $a){
    echo '$a == 1';
}

明显,常量放在前面的话,编译器就能判断错误。

正规格式:

$a = 1;
if(1 == $a){
    echo '$a == 1';
}

 

 
查找表法
 
之前:
/*错误码:4,5,7,8的时候返回状态1,错误码是1,3,6返回状态2*/
$error = 4;
$state = 0;
if($error == 4 || $error == 5 || $error == 7 || $error == 8){
    $state = 1;
}
 
if($error == 1 || $error == 3 || $error == 6){
    $state = 2;
}
echo "$state \n";

 

之后:
/*错误码:4,5,7,8的时候返回状态1,错误码是1,3,6返回状态2*/
$error = 4;
$state = 0;
 
$arr = array(4 => 1, 5 => 1, 7 => 1, 8 => 1, 1 => 2, 3 => 2, 6 => 2);
isset($arr[$error]) && ($state = $arr[$error]);
 
echo "$state \n";

 明显代码更加凝练,更加清楚,更易懂,速度也更快!

总结
 
本来想把什么设计模式也往常用代码里放置,但是太多了,不太好放。这些只是微部而已!
大家如果有更好的写法的话,可以留言。
分享到:
评论

相关推荐

    PHP代码规范

    ### PHP代码规范详解 在软件开发领域,代码规范扮演着至关重要的角色,它不仅能够提升代码的可读性和可维护性,还能够帮助团队成员更好地协作。本文将深入解析一份关于PHP编码规范的文档,旨在为PHP开发者提供一套...

    php代码规范

    ### PHP代码规范详解 #### 一、引言 在软件开发过程中,良好的代码规范不仅可以提升团队协作效率,还能显著提高代码质量与可维护性。本文档旨在为PHP开发者提供一套全面且实用的代码规范指南,帮助团队成员快速...

    Android和php代码规范1

    Android和PHP代码规范指南 在软件开发中,代码规范是非常重要的,因为它可以提高代码的可读性、可维护性和可重用性。本文将介绍Android和PHP代码规范,帮助开发者编写高质量的代码。 一、包命名规范 包命名规范是...

    代码规范+-+PHP+代码风格检查_修复工具_修复脚本_php_php编程_

    "PHP代码风格检查_修复工具_修复脚本"这一主题,涉及到的是如何使用工具来检查并修正PHP代码中的风格问题,以符合最佳实践。 PHP编程规范,通常指的是PSR(PHP Standard Recommendations)标准,由PHP框架和库的...

    PHP-CodeSniffer-3.3.2 PHP代码规范检查工具

    PHP_CodeSniffer是一款自动化的PHP代码规范检查工具。CodeSniffer内置MySource、PEAR、PHPCS、PSR1、PSR2、Squiz和Zend等几套代码规范。当然,你也可以新增自己的代码规范。PHP_CodeSniffer包含两个工具,phpcs用来...

    PHP代码编写规范.doc编程资料

    PHP代码编写规范.doc

    适用于 PHPSTROM 的 PHP代码规范格式化文件

    1. 导入 PHPSTROM 来使用 2.使用快捷键 CTRL + ALT + L 来格式化代码

    工作中整理的前后端技术文档与代码规范

    PHP代码规范部分可能涉及变量命名、函数设计、注释、错误处理和性能优化等。例如,可能会规定: 1. 变量名应清晰,使用骆驼命名法。 2. 函数应简洁,避免过长的函数,每个函数应只做一件事。 3. 注释要清晰,包括...

    总结PHP代码规范、流程规范、git规范

    ### PHP代码规范 #### 命名规范 1. **变量命名规范**:使用驼峰命名法,避免拼音或拼音加数字的命名方式。变量应具有描述性,包数字母、下划线字符,避免其他特殊字符。变量命名应尽量使用项目中有据可查的英文...

    PHP 代码规范小结

    以下是一些关键的PHP代码规范要点: **命名规范** 1. **类文件**:类文件应以`.class.php`为后缀,使用驼峰命名法,且首字母大写,例如`Pay.class.php`。 2. **类名**:与目录文件名保持一致,如`Zend_Autoloader`...

    PHP代码书写规范

    【PHP代码书写规范】 PHP代码书写规范是为了提高代码可读性、可维护性和团队协作效率而设立的一套指导原则。这些规范涵盖了文件命名、变量、常量、函数、类以及编码格式等多个方面。遵循这些规范,可以帮助程序员...

    PHP代码命名规范(PHP Coding Standard)

    此外,命名空间(Namespace)的使用也是PHP代码规范的一部分。它们帮助避免命名冲突,应使用反斜杠(\)作为分隔符,例如`App\User`。命名空间的名称通常反映了代码的层次结构。 类属性和方法的可见性(public, ...

    php开发代码规范.docx

    **PHP 开发代码规范** 1. **编码风格一致性** - 编码规范的主要目标是确保团队中的所有成员遵循统一的代码风格,这样可以提高代码的可读性和可维护性,减少因个人习惯差异带来的理解障碍。 - 规范化代码格式包括...

Global site tag (gtag.js) - Google Analytics