网页编程代码书写规范

网页编程,也就是网页代码的编写,其实也就是编程代码的书写,一个好的网站,其网页编码,是比较规范的,条理清晰,格式简洁美观,可读性强,那到底怎样才能规范好代码的编写规范,是一个值得大家深思的问题,想想自己以前的编码是怎样的,而现在编码又是怎样的?
  
  大家一定会发现,自己的编码随着时间的慢慢积累,可能会形成自己的一套风格,比如大括号(花括号)要在同一列,相同标签要缩进,对齐等等。即使我们有自己的风格,但我们也会慢慢改进代码的编写规范,比如加入版权,加入一定数量的代码注释,适当地进行格式的缩进等。由于现在的网站代码可移植性非常高,如果我们每个人都能按照某种规范来编写代码,那么在我们得到其它人的代码时,我们能更好地理读代码,学习编码者的编程思路,必要的时候进行改进,制作出新的特效,新的程序,这对于程序开发是非常有益的,如果你的编码,拿给你的朋友,学生看,你能保证他们都能准确理解吗?至少代码的思路能不能正确的传达给对方,让更多的人能清晰地看懂我们的代码,这才是我们对代码可移植性的贡献。
  
  在网络公司里,通常一个Web程序,都是由项目总监带领技术人员和美工人员多人协调配合完成,这时候,规范代码就显得非常重要,如果你是一个程序员,那你的代码要让其它的程序员能够清晰地理解并使用,并且也能让项目制作组每个人都看得懂才行,这就是一种代码的规范性,虽然这是在公司内部,但是,代码一但规范,在更多的地方,都是相类似的,只要相应的作说明,都能让其他人很快理解,代码书写规范,越来越被程序编写人员使用。
  
  同时,拥有编程规范意识的程序员,通常项目都会做得比其它人更胜一筹,并不是他做程序比较快,而是它制作的程序一但出错,查错和改错他本人都能很快解决,从而缩短了程序开发周期。通常我们编写代码最好借助一些文本编写工具,会让我们用起来得心应手,比起Windows自带的记事本,这些软件都要好用得多,笔者强烈建议读者选择“NotePad++”文本编写工具,编写界面有行号,找错非常快捷方便,同时支持多窗口打开,多种代码风格,比如写C语言时,关于C的关键字都会高亮显示,编写asp,php语言,同样的关键词都能高亮显示,便于检查自己有没有拼写错误,喜欢写代码的朋友必备的文本编辑工具之一。
  
  由于代码书写规范,很多程序员都有他自己认为比较好的风格,但是能遵循大多数编程人员的编写风格,才是一种好的习惯,下面为大家提供一段规范代码的建议,只要你按此思路写代码,我相信大多数人都能很快读懂你的代码,并且在别人看来,能写出这么规范的代码的程序员肯定技术也是非常不错的,有自己编写风格的朋友,同样可以借鉴此方法,让自己的代码更清晰地展示给大家。以下是引用内容:
  
  1.代码标记:比如HTML语言中,有许多单标签和双标签,在xhtml中,单标签打开后还要记得关闭,如<hr>要写成<hr />,用一个斜杠将标签关闭;另外xhtml中要求标签要统一为小写字母,比如<A>链接</A>链接标记要写为<a>链接</a>;属性在赋值的时候都要加上引号,如<table border=1 align=center>要规范为<table borer="1" align="center">; 在asp中,要尽量使用<%=%>简化代码;而在PHP程序中,虽然可以使用<?=?>或者<??>等来界定PHP代码,虽然在HTML页面嵌入纯变量时,可以使用<?=?>这种形式,但是为人倡导代码规范化和标准化,以及保证程序的可移植性等,我们最好统一用标准的<?php ?>这种界定形式。
  
  2.文件头的声明和标识:在我们源文件头部需要写一个文本标识段,以便对我们每次对源文件的任何改动,都可以在段中注明,通常这段在每个页面的开头部分。在php中我们可以沿用C语言的“/**/和//”来进行标注,在HTML中可以用“<!--文字内容:我是中国站长站 www.54cnzz.com -->”标记等。
  
  3.注释:一位前辈说过,一份好的代码,有50%以上的注释,才是正常的,这句话在今天我们看来,真是非常正确!别小看代码的注释作用,当你编写的代码较多且复杂时,你会发现代码注释是多么重要的事情。注释是对于那些容易忘记作用的代码添加简短介绍,我们要求每个函数方法面前都必须要有注释,每个变量、常量等在定义时都要有注释,类、接口、结构体等前面都要有注释。同时记住,注释只可以写在代码的上边或右边,切不能写在代码的下面。
  
  4.代码的书写规则在PHP,ASPhttp://zzdxjyzd.com,JavaScript中的函数,类,逻辑结构和循环等,每个缩进的单位约定是一个TAB(8个空白字符宽度),以防止在编写代码时遗忘造成格式上的不规范。大括号(花括号){}、if和switch的首括号与关键词同行,尾括号与关键词同列表;在if结构中,else和elseif与前后两个大括号同行,左右各一个空格。另外,即使if后只有一行语句,仍然需要加入大括号,以保证结构清晰;switch结构中,通常一个case块处理后,将跳过之后的case块处理,因此大多数情况下需要添加break。break的位置视程序逻辑,与case在同一行或另起一行均可。但同一switch体中,break的位置格式应当保持一致。
  
  5.运算符,小括号,空格,关键词和函数:每个运算符与两边参与运算的值或表达式中间要有一个空格,唯一的特例是字符连接运算符号两边不加空格;左括号"("应和函数关键词紧贴在一起,除此外应该使用空格将"("同前面的内容分开;右括号")"除后面是")"或者"."之外,一律用空格隔开它们;除字符串中特意需要,一般情况下,在程序以及HTML中不出现两个连续的空格;任何情况下,PHP程序不能出现空白的带有TAB的空格的行,同时,任何程序行尾也不能出现多余的空格或TAB。每段较大的程序体,上、下应当加入空白行,两个程序块之间只使用一个空行,禁止使用多行。程序块划分尽量合理,过大或者过小的分割都影响他人对代码的阅读和理解。一般可以以较大函数定义、逻辑结构、功能结构进行划分。少于15行的程序块,可不加上下空白行;说明或显示部分中,内容如含有中文、数字、英文单词混杂,应当在数字或者英文单词前后加入空格。
  
  6.引号:PHP中单引号和双引号具有不同意义,最大的几项区别是在单引号中,任何变量、特殊转义字符(如“\t\r\n”等)不会被解析,因此PHP的解析速度更快,转义字符仅仅支持"\'"和"\\"这样对单引号和反斜杠本身的转义;双引号中,变量值会代入字符串中,特殊转义字符也会被解析成特定的单个字符,还有一些专门针对上述两项特性的特殊功能性转义,例如"\$"和"{$array['key']}"。这样虽然程序编写更加方便,但同时PHP的解析也很慢慢;数组中,如果下标不是整型,而是字条串类型,请务必用单引号将下标括起,正确写法为$array['key'],而不是$array[key],因为不正确的写法会使PHP解析器认为key是一个常量,进而先判断常量是否存在,不存在时才以key作为下标代入表达式中,同时触发错误码事件,产生一条Notice级错误。因此,在绝大多数可以使用单引号的场合,禁止使用双引号。
  
  7.命名原则:变量、对象、函数名一律为小写格式,除非必要,单词之间一般不使用下划线进行分割;以标准计算机英文为蓝本,杜绝一切拼音或拼音英文混杂的命名方式,变量名只能使用项目中有据可查的英文缩写方式;也可以合理地对过长的命名进行缩写。常量应该总是全部使用大写字母命名,少数特别必要的情况下,可以使用下划线来分隔单词;php的内键值TRUE、FALSE和NULL必须全部采用大写字母书写。
  
  8.代码重用:代码的有效重用可以减少效率的损失与资源的浪费。在开发软件项目时为了避免重复劳动和浪费时间。开发人员应尽量提高现有代码的重用率,同时将更多的精力用在新技术的应用和新功能的创新开发上面。在需要多次使用代码,并且对于您希望实现的任务没有可用的内置PHP函数时,不吝啬定义函数或类。开发者须根据功能、调用情况,将函数和类放置于相应的.func.php或.class.php中。超过三行,实现相同功能的程序切勿在不同程序中多次出现,这是无法容忍和回避的问题;在任何时候都不要出现同一个程序中出现两段或更多的相似代码或相同代码,即便在不同程序中,也应尽力避免。开发者应当总是有能力找到避免代码大段(超过10行)重复或类似的情况。任何产品开发者必须时刻清楚和理解代码重用的重要性和必要性,切实在增强产品效率、逻辑性和可读性格上下工夫,这是一名优秀软件开发者所必须具备的基本素质。
  
  无论你已经自成一种风格还是正在学习中,保证编程代码规范性,是一个好习惯,同时也是你一步步走向高级程序员的必经之路。更多关于编程代码规范的文章,欢迎光临我是中国站长站 www.54cnzz.com ,本文于本站首发,欢迎转载并注明本链接。本文参考资料(高洛峰《细说PHP》),关键词“代码书写规范”“编程代码规范”“网页编程代码”“编码书写规范”“编程规范”“代码规范”等均由百度搜索提供,更多资料,百度一下,你就知道。

猜你喜欢

转载自www.cnblogs.com/dakunqq/p/11462857.html