首页 PHP规范化实践——编码规范

PHP规范化实践——编码规范

11761 67 355 2018 / 12 / 21

目的:

    当一个软件项目尝试着遵守公共一致的标准时,可以使参与项目的开发人员更容易了解项目中的代码、弄清程序的状况。使新的参与者可以很快的适应环境,防止部分参与者出于节省时间的需要,自创一套风格并养成终生的习惯,导致其它人在阅读时浪费过多的时间和精力。而且在一致的环境下,也可以减少编码出错的机会。缺陷是由于每个人的标准不同,所以需要一段时间来适应和改变自己的编码风格,暂时性的降底了工作效率。从使项目长远健康的发展以及后期更高的团队工作效率来考虑暂时的工作效率降低是值得的,也是必须要经过的一个过程。标准不是项目成功的关键,但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。


    • 程序员可以了解任何代码,弄清程序的状况

    • 新人可以很快的适应环境

    • 防止新接触PHP的人出于节省时间的需要,自创一套风格并养成终生的习惯

    • 防止新接触PHP的人一次次的犯同样的错误

    • 在一致的环境下,人们可以减少犯错的机会

    • 程序员们有了一致的敌人



规范:

  • 代码标记

    PHP程序可以使用<?php ?>来界定 PHP 代码,在HTML页面中嵌入纯变量时,可以使用<?php echo $variablename;?>这样的形式。

    注意:为了使代码进一步规范化和标准化,从Discuz! X2版本起开始禁用<? ?><?=$variablename?>这种速记形式。

  • 注释

    注释是对于那些容易忘记作用的代码添加简短的介绍性内容。请使用 C 样式的注释“/* */”和标准 C++ 注释“//”。

    注意:程序开发中难免留下一些临时代码和调试代码,此类代码必须添加注释,以免日后遗忘。所有临时性、调试性、试验性的代码,必须添加统一的注释标记“//debug”并后跟完整的注释信息,这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。

    如:

  • $num = 1;
    $flag = TRUE; 	//debug 这里不能确定是否需要对$flag进行赋值
    if(empty($flag)) {
    	//Statements
    }