关于编程规范

制定规范有很多好处,下面就列举其中的一些

  • 程序员可以了解任何代码,弄清程序的状况
  • 新人可以很快的适应环境
  • 防止新接触PHP的人出于节省时间的需要,自创一套风格并养成终生的习惯
  • 防止新接触PHP的人一次次的犯同样的错误
  • 在一致的环境下,人们可以减少犯错的机会

在一个团队里面更是需要制定规范,统一编码,一旦达成规范,必需按规范执行。项目的代码,很容易就会被其他程序员看懂,减少误解,提高效率。

下面谈谈应该制定哪些规范,我结合自身的开发经验总结以下几项:

1.代码标记,如今很多PHP程序员贪图方便,往往在页面插入PHP代码时的格式为

<? ?>
<?=$variablename?>

这样虽然快,未来版本PHP可能会开始不建议使用甚至取消,所以在发布的时候务必把上述代码改为

<?php ?>
<?php echo .....?> 

2.注释问题

相信很多人一开始学编程语法的时候,最初开始除了学习怎么声明变量,接着就是如何注释代码。

有些人急于看到最终效果,往往注重的是代码所得出的结果,而把得出结果的过程给忘了。我曾经写过一个过河游戏,记得当初写完的时候整个程序连一行注释也没有,就算是交给老师看,无意义的变量名,让人根本就摸不清到底是哪里打哪里。

意识到注释是相当重要的。例如:定义函数体上方,注释该函数的作用,每一个参数的意思,返回的结果是什么等等。以后别人运用的时候就即省心又省力。

所有临时性、调试性、试验性的代码,必须添加统一的注释标记//debug”并后跟完整的注释信息,这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。


3.书写规则-缩进

很多软件都会自带这种功能,目前我自己用的是DW CS5,以前老不会多行减少缩进,原来很简单,就是按住shift键再按tab键就可以多行同时缩进了。

对于HTML格式,DW有个格式化代码工具。

对于PHP格式,editplus可以添加组件工具PHPCB,网上可以下载,然后自行安装。

以前经常会遇到打开JS文件,里面的代码格式都是挤在一起很凌乱的,可以在百度搜索JS美化,有一款应用可以解决这问题,还有就是Eclipse也可以,不过我没有试过。

4.常量

在整站中,如一些关于权限问题的设置,可以运用常量来判断改用户是否有权限访问,例如PHPCMS

define('IN_PHPCMS', true);

5.关于引号

单引号中,任何变量($var)、特殊转义字符(“\t \r \n”)不会被解析,因此PHP的解析速度更快,转义字符仅仅支持“\’”“\\”这样对单引号和反斜杠本身的转义;
双引号中,变量($var)值会代入字符串中,特殊转义字符也会被解析成特定的单个字符,还有一些专门针对上述两项特性的特殊功能性转义,例如“\$”“{$array[‘key’]}。这样虽然程序编写更加方便,但同时PHP的解析也很慢;

用单引号的情况包括但不限于下述:

  • 字符串为固定值,不包含“\t”等特殊转义字符;
  • 数组的固定下标,例如$array[‘key’]
  • 表达式中不需要带入变量,例如$string = ‘test’;,而非$string = “test$var”

在正则表达式(用于preg_系列函数和ereg系列函数)中,全部使用双引号,这是为了人工分析和编写的方便,并保持正则表达式的统一,减少不必要的分析混淆。

数据库SQL语句中,所有数据都不得加单引号,但是在进行sql查询之前都必须经过intval函数处理;所有字符串都必须加单引号,以避免可能的注入漏洞和SQL错误。

所有数据在插入数据库之前,均需要进行addslashes()处理,以免特殊字符未经转义在插入数据库的时候出现错误。

如果数据处理必要(例如用于直接显示),可以使用 stripslashes() 恢复,但数据在插入数据库之前必须再次进行转义。


6.命名规则

变量、对象、函数名一律为小写格式除非必要,单词之间一般不使用下划线“_”进行分割;以标准计算机英文为蓝本,杜绝一切拼音、或拼音英文混杂的命名方式;

变量命名只能使用项目中有据可查的英文缩写方式,例如可以使用$data而不可使用$data1$data2这样容易产生混淆的形式,应当使用$articledata$userdata这样一目了然容易理解的形式;

今天先说到这里,算是编程以来就一点点关于规则的总结。



posted on 2011-10-17 16:10  playeah  阅读(163)  评论(0)    收藏  举报