PHP编码规范文档.doc

《PHP编码规范文档.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、PHP编码规范目录1目的22使用角色23适用范围24文档格式定义25命名25.1命名的统一原则25.2常量命名25.3变量命名25.4子程序命名35.5接口命名35.6类命名35.7网站默认首页命名45.8文件命名45.9数据库方面命名46注释46.1总原则46.2规范46.2.1类的注释46.2.2接口的注释56.2.3子程序的注释57代码书写风格67.1总原则67.2控制结构67.3单条语句77.4注释87.5子程序87.6类98PHP性能规范91目的提高开发效率；降低程序的复杂度；提高代码可读性。2使用角色3适用范围所有的PHP程序开发人员，PHP代码质

2、量检测人员4文档格式定义²实例：以此背景色显示的表格内容²建议规范，如下形式的语句为建议性的规范，不强制要求（包括字体颜色与“（建议）”双标识）：用空行进行段落分隔（建议）。5命名5.1命名的统一原则反映现实世界的问题5.2常量命名²具名常量是根据所代表的抽象实体而不是它所代表的数字来命名²全部大写，使用“_”分隔单词Ø例子：DEFINE('CMS_ROOT',DIRNAME(__FILE__));5.3变量命名²全局变量以“g_”开头，非全局变量不要以“g_”开头Ø例子：$g_staticDel$memberCount²变量名反映了现实世界的问题²充分描述此

3、变量的用途²所有的“临时”变量都重新命以更有意义的名字Ø例子：$discriminant=sqrt(pow(b,2)-4*a*c);$root[0]=(-b+$discriminant)/(2*a);$root[1]=(-b-$discriminant)/(2*a);²以小写字母开头，从第二个单词开始，每个单词的第一个字母大写，其余小写Ø例子：$memberIndex²避免出现字母完全相同，仅大小写不同的命名²不允许在命名的结尾使用下划线²不要出现单字母的变量，如i,j,k（只有在控制循环数时且循环代码条数在3条以内，才可以考虑使用）²循环下标的名字要有意义（

4、如果循环的长度超出了一两行代码或者出现了嵌套循环，那么就应该是i、j或者k以外的其他名字）Ø例子：for($teamIndex=0;$teamIndex<$teamCount;$teamIndex++){for($eventIndex=0;$eventIndex<$eventCount[$teamIndex];$eventIndex++){$score[$teamIndex][$eventIndex]=0;}}²变量中不要出现数字²用count或者total来代表总数，用index来指代某个特定成员。名字中用count或者index来代替num把限定词放在名字

5、最后的例外，num已经是约定俗成的。num放在变量名的开始位置代表一个总数：numCustomers表示的是员工的总数。num放在变量名的结束位置代表一个下标：customerNum表示的是当前员工的序号。通过numCustomers最后代表复数的s也能够看出这两种应用之间的区别。然而，由于这样的使用num常常会带来麻烦，因此可能最好的办法是避开这些问题，用count或者total来代表员工的总数，用index来指代某个特定的员工。这样,customerCount就代表员工的总数，customerIndex代表某个特定的员工。²如果有计算限定符，把限定词加到名

6、字的最后。（建议）优点：保证变量的主要含义部分位于最前面，这样这一部分就可以显得最为突出，并会被首先阅读到。其次，避免同时在程序中使用tatalRevenue和revenueTotal（总收入）而产生歧义。（建议）Ø例子：$revenueTotal=0;//总收入$expenseTotal=0;//总支出$revenueAverage=0;//平均收入$expenseAverage=0;//平均支出1.1子程序命名²第一个单词小写，后面的单词第一个字母大写²不要仅通过数字来形成不同的子程序名字²第一个单词必须是动词，使函数的意义清晰明了,例如：openAcco

7、unt()²存取对象的子程序使用setXXX()和getXXX()函数形式Ø例子：getFirstName();setFirstName($firstName);²访问布尔类型的子程序可以使用isXXX（）函数²例子：//以下都是比较好的命名：printDocument()、checkOrderInfo()1.2接口命名²接口名的开头加上字母“I”前缀。这可以明确区分接口和类²从第二个字母起，用首字母大写的英文单词描述接口²例子：IRunable、ISingleton1.3类命名²用第一个字母大写的英文正常语序准确描述类的含义。如：Employee²所有的类属

8、性全部以“_”开头，同其它变量区分开²