工作点滴--看代码的感受

今天在学习代码,用了1天的时间,看了几K的代码,看来有点慢了,

不过收获不小,以前看代码一般是找到一个模块的开头,然后就开始往下看,一直看到吐血,再回头,才发现自己刚才,不知道刚才看了什么,也不知道代码的具体作用,一旦出来问题,又要重新开始看这段代码.

现在有几点感悟.

 1.看代码,要知道里面重要的数据结构,因为从代码组织上来看,代码都是围绕这些数据结构进行组织和编写的,

2.看代码,要明确代码是实现什么功能,在整个系统中处于什么层次,,这样别人问你这个模块的问题,或者系统出现了和这个模块相关的问题,你就能很快知道是在什么地方出了问题,当然还要看代码才能知道,具体是哪出了问题.

3.看代码,要及时进行总结.包括两个层次的总结.一类是概括性的总结,即能让别人知道这个模块起到什么作用,在整个系统中占有什么地位,出了问题是不是和这个模块有关系.  另一类是类似代码走读的总结,有点类似伪码,但要比伪码,更具有概括性,也有点类似程序流图,这里以代码的主干为前提,进行总结,适当的添加注释.也就是对这段代码的说明,总结是可采用思维导图的形式,节点是函数名称.

 

4.看代码,如果有状态的话,一定要有相应的状态迁移图,或者表格等进行说明,尤其是多个状态机存在的情况下.