如何写一个代码分析文档

1.给出这段代码的功能描述,让读者知道这篇文章主要介绍哪一部分

2.这段代码入口方法,以及如何找到入口类、方法

3.给出结论的代码调用图

(1)跟那些组件有交互

(2)跟哪些关键类代码有交互

4.具体代码说明

(1)关键的方法调用链路,文字描述/图

(2)定义了哪些主要的数据结构,写出数据结构中存了什么信息

(3)如果和多线程有关,说明线程之间的调用关系

5.总结

(1)重要的数据结构

(2)为何这样设计,有哪些好的设计点,或者个人觉得设计的巧妙之处

(3)有哪些不好的设计——觉得可以怎么改进

(4)联想——其他系统里有哪些类似功能,如何实现的?

(5)这部分代码中有哪些参数可供调优?

发布了52 篇原创文章 · 获赞 4 · 访问量 5万+

猜你喜欢

转载自blog.csdn.net/Gloria_y/article/details/102074642