让代码分段和缩进

       一种提高代码可读性的方法是给代码分段，换句话说，就是在代码块内让代码缩进。所有在括号 {和 }之内的代码，构成一个块。基本思想是，块内的代码都应统一地缩进去一个单位。缩进由四个空格组成，禁止使用制表符 TAB 。

       一行 80 字符以内是比较合适，在有些情况下，长点也可以, 但最多为 120 个字符。
行结束标志,行结束标志遵循 Unix 文本文件的约定，行必需以单个换行符（LF）结束。换行符在文件中表示为 10，或16进制的 0x0A。
       注：不要使用 苹果操作系统的回车（0x0D）或 Windows 电脑的回车换行组合如（0x0D,0x0A）。
 
在代码中使用空白
       在代码中加入几个空行，也叫空白，将代码分为一些小的、容易理解的部分，可以使它更加可读。建议采用一个空行来分隔代码的逻辑组，例如控制结构，采用两个空行来分隔成员函数定义。没有空白的代码很难读，很难理解。
 
遵循30秒法则
       其他的程序员应能在少于 30 秒钟的时间内完全理解你的成员函数，理解它做什么，为什么这样做，它是怎样做的。如果他们做不到，说明你的代码太难维护，应加以改进。30 秒钟，明明白白。 一个好的经验法则是：如果一个成员函数一个屏幕装不下，那么它就很可能太长了。
 
每行只做一件事情
        每一行代码只做一件事情。在依赖于穿孔卡片的计算机发展的早期，想让一行代码完成尽量多的功能的想法是可以理解的。若想在一行里做多件事情，就会使代码难于理解。为什么要这样呢？我们应使代码尽量容易理解，从而更容易维护和改进。正如同一个成员函数应该并且只能做一件事一样，一行代码也只应做一件事情。
此外，应让代码在一个屏幕内可见。 也不应向右滚动编辑窗口来读取一整行代码，包括含有行内注释语句的代码。
 
说明运行顺序
        提高代码可读性的一个相当简单的方法是使用圆括号来说明PHP代码运行的准确顺序。如果为了理解你的源码而必须了解编程语言的操作顺序，那么这说明源码中一定有什么重要的东西做的不对。 这大多是在 AND 或者 OR 其它几个比较关系处产生的逻辑比较上的问题。
        注意：如果你象前文所建议的那样，采用短小单独的命令行，那么就不会产生这个问题。
 公共和保护接口最小化原则     面向对象程序设计的基本点之一是最小化一个类的公共接口。这样做有几个理由：
   1  可学习性。要了解如何使用一个类，只需了解它的公共接口即可。公共接口越小，类越容易学习。
  2  减少耦合。当一个类的实例向另一个类的实例或者直接向这个类发送一条消息时，这两个类变得耦合起来。最小化公共接口意味着将耦合的可能降到最低。
  3 更大的灵活性。这直接与耦合相联系。一旦想改变一个公共接口的成员函数的实现方法，如你可能想修改成员函数的返回值，那么你很可能不得不修改所有调用了该成员函数的代码。公共接口越小，封装性就越大，代码的灵活性也越大。
    4 尽力使公共接口最小化这一点明显地很值得你的努力，但通常不明显的是也应使被保护接口最小化。基本思想是，从一个子类的角度来看，它所有超类的被保护接口是公共的。任何在被保护接口内的成员函数可被一个子类调用。所以，出于与最小化公共接口同样的理由，应最小化类的被保护接口。
 
    首先定义公共接口。大多数有经验的开发者在开始编写类的代码之前就先定义类的公共接口。 第一，如果你不知道一个类要完成怎样的服务/行为，你仍有一些设计工作要做。第二，这样做使这个类很快地初具雏形，以便其他有赖于该类的开发者在“真正的”类被开发出来以前至少可以用这个雏形开始工作。 第三，这种方法给你提供了一个初始框架，围绕着这个框架你构造类
 

 给代码注释
       记住：如果你的代码不值得注释，那么它就不值得保留。当正确地使用了本文提到的注释标准和方针，就可以大幅度地提高代码质量。
 
      这是烟寒网络团队多年从事网站建设工作以来，形成的一套规范，希望同业共享，提高网站建设质量。

---

---

分享联系我们

扫二维码与项目经理沟通 我们在微信上24小时期待你的声音

感谢您的关注分享“南宁烟寒网络公司网站建设团队编码规范”
烟寒网络真诚为您服务 ，点击客服直接咨询下单.

立即咨询