ecshop编码命名规范

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

1、ECSHOPv2.x代码规范ECSHOP编码规范1.编辑器设定1.1.缩进所有的缩进使用空格取代Tab制表符。PHP文件采用4个空格的缩进，HTML文件以及HTML文件中嵌入的Javascript代码采用2个空格的缩进；单独的Javascript以及CSS文件采用4个空格的缩进。1.2.字符编码所有PHP、HTML文件均保存为NoBomUTF-8的字符编码。变量名应当全部小写，并且词语之间以单个下划线分隔。例如：$current_user是正确的，但是$currentuser和$CurrentUser就不正确。名称应当是描述性的，并且简明。我们自然不希望使用冗长的句子作为变量名，但是多输入几

2、个字符总好于疑惑于某个变量到底是干什么用的。1.3.循环计数器允许使用一个单字符变量名的唯一情形是当它作为一个循环计数器的时候。在这种情况下，外层循环的计数器应当始终是$i。如果有一个循环处于这个循环的内部，它的计数器应当是$j，进而是$k，等等。如果循环的计数器是一个已经存在并且名字有意义的变量，本规范并不适用。例如：for($i=0;$i<$outer_size;$i++){  for($j=0;$j<$inner_size;$j++)  {    foo($i,$j);  } }ECSHOPv2.x代码规范1.1.函数名称函数也应该描述性地命名。这里我们并非在用C编程，我们不希望写出诸

3、如“stristr()”此类的函数来。同上，使用单词间用单下划线分隔的小写名称。函数名称中某处最好有一个动词。较好的函数名称如print_login_status()，get_user_data()，等等。1.2.函数参数参数遵循和变量名字相同的约定。我们不希望一堆这样的函数：do_stuff($a,$b,$c)。在大部分情况下，我们希望仅仅看看函数的声明，就知道怎样使用它。1.3.类的名称类的名称首先必须是一个有意义的英文单词或者词组。同时在书写格式上为了使类名和函数、变量有一个区别，我们要求类的名称全小写的写法，并且加上cls_作为前缀。例如：/*错误的写法*classimage_han

4、dle{}classimagehandle{}classimageHandle{}/*正确的写法*classcls_imagehandle{}1.4.总结这里的基本哲学是不要为了偷懒而伤害了代码的清晰。但是，必须由一些常识来掌握这种平衡；例如，print_login_status_for_a_given_user()做得就过火了——这个函数命名为print_user_login_status()更好些，或只是print_login_status()。2.代码布局这里是一个头部的模板，所有的PHP文件的开始都必须包含下面的内容：/***ECSHOP升级程序之控制器*==============

5、==============================================================*版权所有(C)2005-2007康盛创想（北京）科技有限公司，并保留所有权利。*网站地址:http://www.ecshop.comECSHOPv2.x代码规范*----------------------------------------------------------------------------*这是一个免费开源的软件；这意味着您可以在不用于商业目的的前提下对程序代码*进行修改、使用和再发布。*============================

6、================================================*$Author$*$Date$*$Id$*/1.1.注释的写法根据流行的注释写法我们要求对于代码段的注释采用以下的方式来书写：/*注释内容*/对于单行的注释则使用下面的注释形式，注意在//之后有一个空格：define(‘IN_ECS’,ture);//注释内容1.2.始终包含大括号这是因为懒于多敲两个字符而给代码清晰带来问题的又一个情形。尽管有些结构的主体部分只有一行，千万不要丢掉大括号。绝对不要。例如：/*这些都错了*/if(condition)do_stuff();if(condition)

7、do_stuff();while(condition)do_stuff();for($i=0;$i