离线下载
PDF版 ePub版

极客学院团队出品 · 更新于 2018-11-28 11:00:43

编码标准

基于实践经验每家公司使用的编码标准不同。编码标准是必要的,因为可能有很多开发人员开发不同的模块,如果他们开始创造自己的标准,那么源代码将会变得非常难以管理,将来进而变得难以维护源代码。

使用编码规范原因如下:

  • 你的同伴程序员必须理解你生成的代码。代码标准充当着所有团队破译代码的蓝图。
  • 通过简单和清晰一致的编码可以避免常见的错误。    
  • 如果你修改代码一段时间后,它变得容易理解了。    
  • 其行业标准遵循特定的软件质量标准,可在 PHP 编码中很少有指南。
  • 缩进和线长-使用 4 个空格缩进而不要使用任何标记, 因为不同的计算机使用不同的标记。建议使用大约 75 - 85字符长度,这样代码可读性更好
  • 控制结构-其中包括 if,for,whilte,switch 等。控制语句中控制关键字之间应该有一个空格和半个括号,来区分函数调用。即使在技术可选的情况下同样强烈建议您始终使用花括号。

例如:

    if ((condition1) || (condition2)) {
        action1;
    } elseif ((condition3) && (condition4)) {
        action2;
    } else {
        default action;
    }

您可以编写 switch 语句如下:

    switch (condition) {
    case 1:
        action1;
        break;

    case 2:
        action2;
        break;

    default:
        defaultaction;
        break;
    }
  • 函数调用,调用函数时,应该与函数名、开括号、第一个参数之间没有空格;与逗号和每个参数有空格,与最后一个参数、整括号、分号之间没有空格。请看示例:
    $var = foo($bar, $baz, $quux);
  • 函数定义,函数声明遵循 “BSD /Allman Style”:
    function fooFunction($arg1, $arg2 = '')
    {
        if (condition) {
            statement;
        }
        return $val;
    }
  • 评论——C 语言评论(/ /)和标准 C++ 语言注释(/ /)都可以。使用 Perl/shell 形式的注释(#)是不可以的。

  • PHP 代码标记——总是使用 < ?php?> 分隔 PHP 代码, 而不是 < ? ?> 速记。这是 PHP 合规所需,也是 PHP 代码在不同的操作系统中设置和安装最便携的方式。

  • 变量名     
    • 使用所有小写字母  
    • 使用这个 “_” 为文字分隔符。  
    • 全局变量预设为 “g”。  
    • 全局常量应该全部大写以 “_” 分隔。  
    • 静态变量可以预设为 “s”。
  • 使函数的可重入——函数不要保持静态变量以防止函数不可重入。
  • 一致性声明块——块声明应该一致。
  • 每行一个声明——每行只应该有一个声明,除非声明非常密切相关。
  • 短的方法或函数——方法应该限制代码在一个单独页面的。

编写 PHP 程序时应考虑的可能会更多。在代码编程中,只有你在按照一种代码标准编程下才会有所有的内涵一致的可能性。如果你喜欢与众不同,你可以设计自己的标准。

上一篇: 文件上传 下一篇: 预定义变量