DoitPHP编码规范

2017-12-12 17:52:163096997187查看评论(0)
DoitPHP编码规范
DoitPHP编码规范基于PHP PEAR编码规范及PHPDocumentor注释规范等编程原则组成,融合并提炼了开发人员长时间积累下来的成熟经验,意在帮助形成良好一致的编程风格。以达事半功倍的效果。为了与时俱进,根据客观需求,本文档会不定期更新。 作者:tommy

适用范围  如无特殊说明,以下规则要求完全适用于DoitPHP项目(注:Doitphp的PHP框架文件,而非使用DoitPHP所开发的PHP项目)。如果你喜欢以下编码规范,也可以用在其它PHP开发项目。 

标准化的重要性和好处 “不以规矩,不成方圆”,当一个软件项目的开发遵守公共一致的标准时,整个团队成员形成并保持一致的编码风格,整个项目文件如同一人所写。每个程序员的代码都易于为他人所理解,提高了代码的可维护性,从而减少了软件的维护成本。同时使新的参与者可以很快的适应环境,从而最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成好的编码习惯,可以减少编码出错的机会,甚至锻炼出更加严谨的思维。将规范“令之以文”是为了明确我们的编码标准。我们相信:标准不是项目成功的关键,但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。

PHP编码规范与原则 1、文件格式   1.1、文件编码:文件编码统一为UTF-8(注:非UTF-8+BOM)。  1.2、PHP代码标记:任何时候都要使用“<?php ?>”来定义你的PHP代码。而“<? ?>”将禁止使用。对于只含有php的代码文件,建议将文件结尾处的“?>”忽略掉,防止多余空格或其它字符影响代码。  1.3、缩进规则:缩进使用4个空格,而不是 TAB。这已经是PHP业界的标准了,我们也不会“逆历史潮流而动”。使用空格主要是为了代码美观整齐。因为在不同的编辑器里, TAB 制表符的长度是不一样的,而空格则是一样的。使用TAB按下TAB键能解决的问题,使用空格则要按四次空格键,明显影响开发效率。目前很多编辑器默认一个TAB占用四个空格位置(占用几个空格,对此编辑器可以调节),如果是这样,为了提高开发效率,可以放心大胆地使用TAB。本缩进规范也适用于JavaScript中的函数、类、逻辑结构、循环等。  1.4、代码内容:每行结尾不允许有多余的空格或TAB制表符(确保你的编辑器保存文件为 Unix 格式,这意味着行是以换行符终止的)。除了语言包注释配置文件,其它地方不能有中文。  1.5、代码注释:文件要有清晰的代码注释,注释风格采用phpDocumentor标准


申明:本站所有资源都是转载各大下载站,或由网友投稿发布,请自行检测软件的完整性,如有侵权请联系我们删除下架,联系方式:admin@php.cn

网页评论
最新评论