Oracle Berkeley DB 中国研发团队的博客

没有规矩，不成方圆。有时候发现，读好的开源产品的代码，如Linux、JDK等，其感受如饮美酒，喜不自胜。然而最近读到一些国内客户和大学毕业生的代码，其感觉就像一个头有十个大，对比很强烈。

千里之行，始于足下。越是历久弥香的产品，越是要求严格，也就意味着每一行代码都很讲究。要做出世界一流的软件来，除了要遵循软件项目管理的种种规范（需求、设计、风险、测试等等），对于开发者的编码要求和规范也不少。

我想，在此谈谈我的一点浅见。对于一个合格的开发者而言，其编写每一行代码的时候，大致首先要考虑的地方有：
- 我遵循相关的代码规范了没有？
- 注释写了没有？注释写的简洁明了吗？
- 针对各种异常情况加以判断和处理了吗？
- 安全退出了吗？释放内存没？有没有内存泄漏？

下面分别简单说明一下。
- 我遵循相关的代码规范了没有？
1. 比如，Sun的Java代码规范要求缩进，貌似很多人注意到了。但是按80个字符折行，你注意到了吗？在咱们Berkeley DB Java版做开发甚至还要求每个函数体不超过一屏幕高。有人不理解，为什么？应为，只有这样，在各种屏幕/环境下看到的你的代码样式都是一致的。从而，方便别人审阅你的代码，也方便了自己。
2. 对变量，函数，类等命名时要遵循代码规范。举个反面例子，假设一个项目组成员10人，有人喜欢用getObject()来命名，有人喜欢readObject()，有人倾向retrieveObj()，有人用getInstance()… 其结局不言而喻。

- 注释写了没有？注释写的简洁明了吗？
举个例子，你要在程序中做排序。你决定实现最简单的冒泡排序。学过计算机的都知道，冒泡排序代价很昂贵，但是若排序的个体数目不大的时候（比如n<10）却用起来不错。所以当你写代码的时候，就应该大致这样写注释：
/**
* We need to sort the elements, since that will allow us to easily index
* into the array. Since the number of elements is expected to be small, it
* is okay to use bubble sort. If the number of elements to be sorted is
* significant, then it would be appropriate to use a more efficient
* sorting algorithm.
*/

- 针对各种异常情况加以判断和处理了吗？
假设有个功能模块，接受从输入流传过来的数据。在理想情况下，预期输入的可能是用户姓名，格式化的：（First, Middle, Last）。那么，我想程序开发者在实现这个功能的时候，应该考虑到，传过来的可能是西文字符集，中文字符集。同样，也有可能是不规则的姓名（First, Last, Middle），空，数字，超出越界（假设每个名字不超过128个字符）。当然，也有可能是内存地址（引用），二进制照片，不可见字符等等。该功能要robust，种种情况都应该要考虑到。

当然，这只是一个输入检查的情况。在程序运行时刻，还有可能遇到内存不够，并发读写等等情况。

- 安全退出了吗？释放内存没？有没有内存泄漏？
安全退出了吗？是的，返回正确退出的信号量了。释放变量了吗？貌似也做了。是吗？接受Ctrl+c吗，结果是什么？

有时候，程序运行几天甚至更久，显示内存不够了，程序自动停止下来。是内存泄漏吗，怎么办？

Java 开发者发现，即便有Java提供的内存回收机制，有很多程序也有内存泄漏，最后导致生产环境应用down掉。

我个人认为：遵循一些编码规范，多测试，多积累经验，不断优化你的code是个不错的建议。

先写到这里, 欢迎有体会或者有兴趣的朋友和我交流哦…