[redis源码注释]-简述

[redis源码注释]-简述

second60 20180510

1 站在巨人的肩膀上

有些人会问：学习一门技术最快的方法是什么？

答案很简单：就是站在巨人的肩膀上，多看多多抄多练。

第一：可以省去我们造轮子，四处碰壁的时间

第二：可以学习巨人的精髓，使自已能力不断的提升

第三：多抄，可以使自已写代码的风格像巨人一样，如火纯青

 

这篇文件不讲技术，纯属非技术分享哈~~

 

学习源码和阅读别人的博客是比较好的方法，也是我提倡的方法，虽然有些时候很难读懂，但慢慢啃，有一天你也会成为大牛。

 

2 关于代码规范-注释

接触过很多开发，每个人都有自已的代码风格，很多技术人员没有写注释的习惯，问他们为什么不加些注释呢？他们会说注释没什么用，没时间写，看代码就好了！！！！

 

我就说说注释吧！

在代码规范里，注释规范是排在首要位置的，重要程度超过了代码。

原因如下：

1. 如果一个类或函数有注释，看注释就可以大概知道这个类或函数是做什么的，能不能使用。如果没有注释，类有上千行代码，或一个函数有上百行逻辑，那么，是看注释省时间，还是看代码省时间呢？看完代码，可能你还不清楚代码里写的是什么！！！

 

2. 复杂的逻辑必须要有注释！

举个例子吧： 某个大牛把一个功能，写成了一行代码！！

够牛吧，如：:(){:|:&};:

以前见过的人肯定知道这是shell的fork炸弹。如果有注释# 这是fork炸弹

那么一看就知道是什么意思！不用去拆分里面的代码是怎么样的。

但如果没有注释，那么你有花不少时间去理解什么意思。最后还不知道是什么意思！！

 

3. 现在大部份公司都喜欢敏捷开发，快速迭代开发，需求量和开发速度是非常紧急，特别是经验少的人，拿到需求，就往一个函数里加代码加逻辑，不花时间来想想怎么样设计，怎么样可以更好的扩展和复用原有的功能。导致函数越来越大，更不能体谅的是，连一句注释也不写。最后，代码量很大时，可读性非常差，更不扩展性可言，最后连写的人都不知道为什么写！系统复杂后，连优化都难，只能放着不动，或者重构原有实现。

如查有注释的话，虽然代码阅读难，但看注释还是可以知道是做什么的。其次，就算是重写，重构，也能比较快速的实现。

 

4. 假如有人写了很复杂的逻辑，很难阅读，如果他还在职，那还好说，问他可能知道是什么原理。但如果他离职了！！那么怎么办？

 

5. 工作越久的人，越会在乎注释，如果是技术管理，首先注释可以减少组员的交流和阅读时间，其次检查组员代码时，可以很快速的看注释和代码，确定代码是否有问题。

 

6. 写代码的人，随着时间的推移，可能半年就忘记他写的代码具体是做什么，当时为什么这样写，但如果有注释，很快就可以回忆起当时写的情景，不是么。

所以，对于说不写注释的人来说，可能是经历比较少吧，还不明白注释的重要性！如果你去金融公司呆过，你可能才知道什么是规范。文档有文档的规范，代码有代码的规范。这些都是比代码更有价值的东西。

    写代码花不了几分钟的时间，却可以减少使用者的理解的时间，何乐而不为呢？

 

3 关于如何阅读redis源码

这里我就不说了，网上有大牛，已经分享了阅读的顺序

http://blog.huangz.me/diary/2014/how-to-read-redis-source-code.html

 

    reids是现在互联网公司很常用的缓存工具，源码也不是很多，很适合用来学习研究。 

4 最后

分享是一种快乐，站在大牛巨上学习更是一种快乐。我写的东西不一定正确，如果有问题的地方，希望指正出来，一起进步。谢谢