一般性原则

 

 

1 遵循原来的编码风格

 

  当更改原来的代码的时候，你的所有改变都应遵循原来的风格，不要引入一个新的风格，不要试图更改原来的代码仅仅用来符合新的风格。在一个文件内拥有不同的代码风格会使程序非常的难以阅读和理解。从写原来的代码来改变它的风格有可能会引入一些可以避免的过失或错误。

2 遵循最少意外原则

              这个原则是建议你尽量减让让你的用户看到意外。

              使一个用户遇到最少的意外，你必须在你的程序中加强以下的这些设计，实现，文档。

简单性   创建简单的类和方法。你需要了解向你的用户展示多少体验。

清晰性   确保所有的类，接口，方法，变量和对象有一个清晰的目的。解释在什么地点，什么时候，为什么要使用他们。

完整性   提供最小的功能，这样有可能是用户可以找到和用到。建立完整的文档，记录所有的特征和功能。

一致性   一致性的实体应该看起来和做的是一样的。建立和应用一个标准在任何可能的情况下。

强壮性   提供文档纪录可能发生的错误和异常。不要隐藏错误和异常。

3 一次就做好

  把这个原则应用到所有你写的代码中，不仅仅是产品中。有些时候，写的一些原型或者试验性代码会引入到最后的产品中。所以你应该避免这些不可预测的事件。即使你的代码从来不会应用到产品中，但是还是会有一些人回来读你的代码的。所有看你代码的人都会感激你把这些原则应用到代码上的职业性和深思熟虑。

 

4 文档和背离

没有哪个标准是完美的和全球通用的。有些时候，你会发现你不得不背离一个已经建立的标准。当你准备背离一个原则的时候，首先你必须要明白这个原则的意义和背离这个原则的后果。如果你决定必须要与这个原则相驳的话，那么记录下来为什么你要这么做。

 

以上这些都是最基本的指导原则。