提升代码可读性的-5个技巧!.doc

《提升代码可读性的-5个技巧!.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、1 -保持一致的缩进假设你已经知道代码需要缩进。不过值得注意的是，最好保持缩进样式一致。缩进代码的方式很多，这里最最常见的两种：风格1:functionfoo(){if($maybe){do_it_now();again();}else{abort_mission();}finalize();}风格2:functionfoo(){if($maybe){do_it_now();again();}else{abort_mission();}finalize();}我以前使用的风格#2，但最近改为#1了。但这个问题只是一个偏好的问题。没有“最好”的风格来让每

2、一个人都去遵循。实际上，最好的风格就是一致的风格。如果你是团队的一员，或者你在向某个项目贡献代码，你就应该遵循项目中正在使用的风格。缩进风格间并不总是会有明显的区别。有时候，不同的规则会产生混淆。比如，在PEAR编码标准中，前大括号“{”与控制结构在同一行，但在函数定义中却需要换行。PEAR风格:functionfoo(){//放在下一行[译者注：示例中明明是放在与声明同行的，可能是作者笔误]if($maybe){//放在同一行do_it_now();again();}else{abort_mission();}finalize();}另外，请注意，缩

3、进是用的4个空格而不是制表符。这里是Wikipedia中不同缩进风格的示例。2-注释和文档IDE（IntegratedDevelopmentEnvironmnet，集成开发环境）在过去数年中已经存在了很长时间。使用IDE注释代码比以往容易得多。某些确切的注释标准可以让IDE和其它工具以不同的方式来完成注释。看个示例：我在这里添加到函数定义前的注释可以在使用函数的时候显示出来，甚至在其它文件中使用这个函数也没问题。下面是另一个示例，关于调用一个第三方库的函数：在这些示例中，注释（或文档）的类型是基于PHPDoc的，使用的IDE是Aptana。3-代码分组

4、某些任务往往不是几句代码就能解决的，那最好把这些任务代码分为不同的代码段，在它们之间添加一些空行。下面是一个简单的示例：//getlistofforums$forums=array();$r=mysql_query("SELECTid,name,descriptionFROMforums");while($d=mysql_fetch_assoc($r)){$forums[]=$d;}//loadthetemplatesload_template('header');load_template('forum_list',$forums);load_tem

5、plate('footer');在每段代码前添加注释可以加强视觉分离效果。4-避免显而易见的注释注释代码非常棒；但是，如果注释只是简单的重复就显得多余了。看看这个示例：//获取国家/地区代码$country_code=get_country_code($_SERVER['REMOTE_ADDR']);//如果国家/地区代码是USif($country_code=='US'){//在表单中显示“州”输入框echoform_input_state();}如果文本是显而易见的，真的没必要在注释里再写一次。如果你一定要在代码里写点注释，可以把它们合并在一行：/

6、/对美国用户显示“州”输入框$country_code=get_country_code($_SERVER['REMOTE_ADDR']);if($country_code=='US'){echoform_input_state();}5-避免深嵌套过多的嵌套层次会使代码变得难以阅读和跟踪functiondo_stuff(){//...if(is_writable($folder)){if($fp=fopen($file_path,'w')){if($stuff=get_some_stuff()){if(fwrite($fp,$stuff)){//..

7、.}else{returnfalse;}}else{为了提高可读性，通常会通过修改代码来减少嵌套的层级：functiondo_stuff(){//...if(!is_writable($folder)){returnfalse;}if(!$fp=fopen($file_path,'w')){returnfalse;}if(!$stuff=get_some_stuff()){returnfalse;}if(fwrite($fp,$stuff)){//...}else{returnfalse;}}