WEB代码篇

内容摘自：
http://sunxboy.iteye.com/blog/283580精典的一句话：
不要 Copy-Paste 你的代码。
当你 Copy-Paste 代码的时候，说明代码中存在重复，重复的代码往往导致代码难以维护和阅读。一旦那些保存在剪切板中的代码中存在错误，编写者甚至不知道到哪里修改这些错误。每当你 Copy-Paste 代码的时候，请停下来，考虑将这些代码提取为方法、类或者组件。

当测试、注释、文档都失去作用的时候，不要忘记，我们还有逻辑，还有代码！代码之前了无秘密。优质的代码是说明应用程序的最根本的方式，是程序员沟通的通用语言。
所以，请认真的编写每一行代码！



●      时刻考虑你所编写的每一行代码、代码中的每一个单词都会在将来某个时候被你的伙伴们阅读、测试和维护。这是一个原则，也是一个前提，是每一个程序员所必须具备的基本素质。在一个团队中，编写可以阅读和维护的代码是团队合作的前提条件。

●    必须认真的慎重的为你的变量、函数（方法）、类命名。要起一个科学合理的名字，因为名字是理解代码的重要依据。同时，一旦代码发布，其依赖者、继承者都要永远维持这种命名。想像一下，如果你和你的同事不得不使用类似“ tj ”这样的名字，而又不能改变现状（会影响其他使用者），那该是一件多么痛苦的事情。

● 为你的代码编写注释。注释是代码的重要组成部分，同时也是别人理解你代码的重要依据，无论任务多么繁重，时间多么紧张，都应该象对待代码一样对待你的注释。哦，还有，最重要的是维护你的代码的同时要维护注释，就像下面一条所说的：

●  请确保注释是有效的。无效的，甚至是错误的注释还不如不写注释，这是显而易见的。注释应该言简意赅，不要用注释重复你的代码，也不要用注释阐述代码中显而易见的逻辑。请原谅我的啰嗦——在维护代码的同时不要忘记维护注释。

●   空行、空格也是代码。空行是一个逻辑段起止的标志，它和编程者的思路是一致的。另外，适当的使用空行和空格可以使你的代码更加清晰。

●   不要耍小聪明。只要有可能，请尽量使用平实的思路来规划你的代码。我们都知道，阅读别人的代码往往比自己编写同样功能的代码要困难，因为阅读代码的过程就是读懂对方思想的过程。困难的原因之一是作者的水平比读者要高——这当然是读者所欢迎的；但是，也可能是因为作者使用了晦涩难懂的思路和技巧，这些技巧五花八门无法列举，下面是常见的几种情况：

1)        过度的使用了设计模式。
这是设计模式初学者经常犯的错误，设计模式是面向对象思想的精华，但是对于经验较少的程序员来说，设计模式是抽象的和复杂的，过多的使用设计模式，会使得代码结构复杂难以理解。

2)        拼凑结果。
例如，某个复杂的函数返回的值总是比预期结果少 1 ，有些程序员会采用 +1 的方式使结果正确。这类做法往往使得代码逻辑混乱莫名其妙，更为严重的是，类似的方法很冗余导致程序中隐藏着错误。

3)        过度封装。
经常遇到的一种情况就是对第三方类库的进一步封装，这必须在有经验的设计者的指导下进行，因为类似的需求往往出现在各种架构级别的模块中。对第三方类库的不合理封装会导致使用着对类库的使用产生异议，出现错误的用法等。

4)        拒绝使用成熟的第三方类库。
许多初级设计人员，往往喜欢自己编写框架级别的代码，例如，在 JavaEE 开发中自行设计 MVC 框架。这类做法在多数情况下都是错误的，因为成熟的产品比比皆是，这些产品都有广泛的用户群、详尽的文档、活跃的社区和大量的成熟案例。普通开发人员极少能够自行编写同样水准的代码，而且，即便写出来了谁又能够保证其他开发人员会使用并且喜欢使用呢。

5)        冒然采用新的技术。
程序员是思维活跃敢于尝试创新的人群，他们往往乐于使用新的技术和新的产品。但是，在使用这些产品之前请仔细考虑：“你了解它吗 ? ”。冒然在团队中应用新技术是一种非常不负责任的行为，学习曲线、隐藏 BUG 、适用范围等等会成为应用新技术的障碍，严重的情况下一个类似的决策会导致整个项目的失败。