discuz x2编码规范

《discuz x2编码规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、编码规范目录1前言·2适用范围·3标准化的重要性和好处·4PHP编码规范与原则o4.1代码标记o4.2注释o4.3书写规则§4.3.1缩进§4.3.2大括号{}、if和switch§4.3.3运算符、小括号、空格、关键词和函数§4.3.4函数定义§4.3.5引号§4.3.6Discuz!语言问题o4.4命名原则§4.4.1变量、对象、函数名§4.4.2常量o4.5变量的初始化与逻辑检查o4.6安全性o4.7兼容性o4.8代码重用o4.9其他细节问题§4.9.1包含调用§4.9.2错误报告级别·5数据库设计o5.1字段§5.1.1表和字段命名§5.1.

2、2字段结构o5.2SQL语句o5.3性能与效率§5.3.1定长与变长表§5.3.2运算与检索§5.3.3结构优化与索引优化§5.3.4查询优化§5.3.5兼容性问题·6模板设计o6.1代码标记o6.2书写规则18/18§6.2.1HTML§6.2.2变量§6.2.3语言元素§6.2.4缩进·7文件与目录o7.1文件命名o7.2目录命名o7.3空目录索引前言本规范由编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。适用范围如无特殊说明，以下规则要求完全适用于Discuz!项目，同时也可大部分适用于COMSENZ

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

4、但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。·程序员可以了解任何代码，弄清程序的状况·新人可以很快的适应环境·防止新接触PHP的人出于节省时间的需要，自创一套风格并养成终生的习惯·防止新接触PHP的人一次次的犯同样的错误·在一致的环境下，人们可以减少犯错的机会·程序员们有了一致的敌人18/18PHP编码规范与原则代码标记PHP程序可以使用来界定PHP代码，在HTML页面中嵌入纯变量时，可以使用这样的形式。注意：为了使代码进一步规范化和标准化，从Discuz!X2版本起开

5、始禁用和这种速记形式。注释注释是对于那些容易忘记作用的代码添加简短的介绍性内容。请使用C样式的注释“/**/”和标准C++注释“//”。在Discuz!每一个程序文件头部中，应放入相应SVN控制字串，以方便SVN提交时自动更新：·$Id$例如：/***[Discuz!](C)2001-2099ComsenzInc.*ThisisNOTafreeware,useissubjecttolicenseterms**$Id$*/程序开发中难免留下一些临时代码和调试代码，此类代码必须添加注释，以免日后遗忘。所有临时

6、性、调试性、试验性的代码，必须添加统一的注释标记“//debug”并后跟完整的注释信息，这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。例如：$num=1;$flag=TRUE;//debug这里不能确定是否需要对$flag进行赋值if(empty($flag)){//Statements}书写规则缩进18/18每个缩进的单位约定是一个TAB(4个空白字符宽度)，需每个参与项目的开发人员在编辑器(UltraEdit、EditPlus、ZendStudio等)中进行强制设定，以防在编写代码时遗忘而造成格式上的不规范。本缩进规范适

7、用于PHP、JavaScript中的函数、类、逻辑结构、循环等。大括号{}、if和switch·首括号与关键词同行，尾括号与关键字同列；·if结构中，else和elseif与前后两个大括号同行，左右各一个空格。另外，即便if后只有一行语句，仍然需要加入大括号，以保证结构清晰；·switch结构中，通常当一个case块处理后，将跳过之后的case块处理，因此大多数情况下需要添加break。break的位置视程序逻辑，与case同在一行，或新起一行均可，但同一switch体中，break的位置格式应当保持一致。以下是符合上述规范的例子：if($condi

8、tion){switch($var){case1:echo‘varis1’;break;case2:echo