该项目开发规范是基于百度EFE的前端代码规范和php-fig的PSR系列规范. 目的是为了提高代码的可维护性,使自己养成良好的编码习惯.
在本文档中,使用的关键字会以中文+括号包含的关键字英文表示.
关键词 “必须”("MUST")
、“一定不可/一定不能”("MUST NOT")
、“需要”("REQUIRED")
、
“将会”("SHALL")
、“不会”("SHALL NOT")
、“应该”("SHOULD")
、“不该”("SHOULD NOT")
、
“推荐”("RECOMMENDED")
、“可以”("MAY")
和”可选“("OPTIONAL")
的详细描述可参见 RFC 2119 。
PHP的编码规范主要采用php-fig制定了一系列PHP开发规范,简称PSR.
FIG是框架互操作工作组(Framework Interoperability Group)的简称,PSR是PHP标准推荐(PHP Standard Recommendation)的缩写.FIG-PHP工作组最初是源于项目代表讨论两个项目之间的共性时,找出可以共事的方式.主要的受众是双方项目组,但PHP界的其他人也在观望.如果其他人愿意采用这里的规范,那么欢迎,但这并非工作组的目标,工作组中没人会告诉你如何来建造应用.