PHP编程的五个良好习惯

将长方法拆分为短方法也是有限制的，过度拆分将适得其反。因此，不要滥用这个良好的习惯。将代码分成大量的片段就像没有拆分长代码一样，都会造成阅读困难。

为代码添加注释

要为代码添加良好的注释有时似乎和编写代码一样难。要了解应该为哪些内容添加注释并不容易，因为我们常常倾向于注释代码当前做的事情。注释代码的目的是不错的主意。在函数的不是很明显的头部代码块中，告诉读者方法的输入和输出，以及方法的最初目标。

注释代码当前做什么是很常见的，但这是不必要的。如果代码很复杂，不得不注释它当前在做什么，这将暗示您应该重写代码，让它更容易理解。学会使用良好的名称和更短的方法，在不提供注释说明其用途的情况下提高代码的可读性。

不良习惯：函数注释过多或不足

清单 5 中的注释仅告诉读者代码在做什么 — 它正在通过一个循环进行迭代或添加一个数字。但它忽略了它为什么 做当前的工作。这使维护该代码的人员不知道是否可以安全地更改代码（不引入新缺陷）。

清单 5. 不良习惯：函数注释过多或不足

以下为引用的内容：
＜?php

class ResultMessage 
{
    private $severity;
    private $message;
    
    public function __construct($sev, $msg) 
    {
        $this-＞severity = $sev;
        $this-＞message = $msg;
    }
    
    public function getSeverity()
    {
        return $this-＞severity;
    }
    
    public function setSeverity($severity)
    {
        $this-＞severity = $severity;
    }
    
    public function getMessage()
    {
        return $this-＞message;
    }
    
    public function setMessage($msg)
    {
        $this-＞message = $msg;
    }
}

function cntMsgs($messages)
{
    $n = 0;
    /* iterate through the messages... */
    foreach($messages as $m) {
        if ($m-＞getSeverity() == 'Error') {
            $n++; // add one to the result;
        }
    }
    return $n;
}

$messages = array(new ResultMessage("Error", "This is an error!"),
    new ResultMessage("Warning", "This is a warning!"),
    new ResultMessage("Error", "This is another error!"));
    
$errs = cntMsgs($messages);

echo("There are " . $errs . " errors in the result.n");

?＞
 
 

延伸阅读:
PHP编程里你所不知道的10个技巧
如何提高你的PHP编程技术
10条PHP编程习惯助你找工作
安全编程法则
php编程人员不得不知的php+mysql网络程序的运行原理