PHP的编码规范.docx

PHP编码规范标签PHP程序可以使用?php ?或?= ?来界定 PHP 代码，在HTML页面中嵌入纯变量时，可以使用?= ?这样的形式，不可使用其他的标签变种。纯PHP类文件，文件最后一个?省略。编码PHP代码必须只使用不带BOM的UTF-8。注释单行注释：在语句结尾用双反斜杠”// “注释多行注释：多行注视以”/*”或“/**”符号开头，以”*/ “符号作为注释结束符。需要生成文档的注释必须是以“/**”开头，以“*/”结尾。主流的IDE开发工具（如Eclipse，Zend）会用不同的颜色来区分下面的几种注释。文件注释/***（简述，用在索引列表中） ** 详细的功能描述（可略） ** @copyright Copyrightcopy; 2013, 公司名或作者名 * @author ${AUTHOR}* @version $Id: ${FILE_NAME}, v ${VERSION} ${TIME} ${AUTHOR} Exp $ * */类注释/***（概要） ** 详细的功能描述* * @property 类型 $prop 属性描述* * @author ${AUTHOR}* @package ponents（参见路径别名）* */方法注释/*** 功能描述* * @param 类型 $fields 描述 ** @return 类型 描述*/属性注释/*** @var 类型 $fields 描述 */ 其它适当的使用HTML标记语言来美化文档。不管是生成HTML格式还是CHM格式的文档手册，文档工具都是先生成HTML文档页面，所以适当的使用br/或b标签可以美化文档，方便阅读。public和private方法：一般情况下，private私有方法不会暴露给其他开发人员，所以private方法的注释一般以“/*”开头，而public方法以“/**”开头。命名规则Pascal命名法：所有单词第一个字母大写，其他字母小写。?Camel命名法(驼峰命名法)?：除了第一个单词，所有单词第一个字母大写，其他字母小写。?采用英文单词或其组合，便于记忆和阅读，切忌使用汉语拼音来命名。?文件类文件的名称和类名一致,如类HelloWorld，相应的文件名为HelloWorld.php配置文件名小写，如 config.php嵌套php的view文件使用Camel命名法，第一个字母小写，其他单词的第一个字母大写。如：addApp.php类类命名采用Pascal命名方法，类名应该和文件名相匹配。函数/方法通常方法一般为一个动作或行为动词，函数/方法的命名采用Camel命名方法?function?run()?function?runFast()?function?getBackground()?尽量用有意义，描述性的词语来命名??用checkForErrors()代替errorCheck()，用dumpDataToFile()代替dataFile()。???有时前缀名是有用的：is?-?含义为问一个关于某样事物的问题。无论何时，当人们看到is就会知道这是一个问题。get?-?含义为取得一个数值。??set?-?含义为设定一个数值??例如：isHitRetryLimit?内部成员函数命名应该是以?“_”开始：function?_isUserTicket?();??变量名用有意义的，描述性的词语来命名变量??别用缩写。用name,?address,?salary等代替?nam,?addr,?sal????全局变量以”g_”?开头?别使用单个字母的变量象i,?n,?x?等.?使用?index,?temp等?，用于循环迭代的变量例外：?for ($i = 0; $i count; $i++) { ... } 常量名量全部使用大写字母和下滑线组成,常量的名称中不允许出现小写字母，可使用分隔符作为下划线。书写规则文件所有的PHP文件必须使用Unix LF(换行)作为行结束符。所有PHP文件必须以一个空行结束。纯PHP代码的文件关闭标签?必须省略行行长度不可有硬限制。行实际长度不应超过80个字符；较长的行应当被拆分成多个不超过80个字符的后续行。空行可以用来改善可读性和区分相关的代码块。一行不应多于一个语句。缩进每个缩进的单位约定是4个空格的缩进，并且不可使用制表符作为缩进，需每个参与项目的开发人员在编辑器(Eclipse、EditPlus、Zend Studio等)中进行强制设定将TAB转化为4个空格，以防在编写代码时遗忘而造成格式上的不规范。 控制结构对于控制结构的样式规则概括如下：控制结构关键词之后必须有一个空格左括号之后不可有空格右括号之前不可有空格在右括号和左花括号之间必须有一个空格代码主体必须有一次缩进右花括号必须主体的下一行每个结构的