快速熟悉项目代码

1 背景

对IT人士而言,换一份工作或进入一个新的公司,往往意味着要熟悉一个新的开发环境,要快速了解新的项目。如何快速地熟悉项目代码,是每个IT人士都会遇到的问题,特别是对刚进入IT职场的应届毕业生,这个问题更显得棘手。下面是我自己在经历几个工作之后结束的一些方法,与大家分享一下,仅贡参考!

2 普通方法

2.1 通读需求文档,了解项目用途

一个企业级的项目,一定会保留一些相关文档吧!比如需求文档,设计文档,项目计划、软件使用说明书等,先通读这些文档,了解项目的用途、主要功能等。

2.2 熟悉开发工具、常用功能

每个公司用的开发环境都会有些不同,要熟悉新的开发环境,了解常用的功能、快捷键等,特别是前后使用习惯相差比较大的开发环境,如从MakeFile到IDE,从Qt 5.8 到 VS2017,从Unix到Windows。

2.3 部署环境,把项目跑起来

了解开发环境后,就把相关的配置部署好,把项目跑起来。

  • 可以进一步实践新的开发环境
  • 把项目跑起来后可以快速地了解项目的用途和功能

2.4 看项目结构

  • 一般项目结构会体现系统结构上的层次,并根据经验和项目命名猜测作者的设计思想

2.5 展开项目目录

  • 根据经验和目录命名猜测作者的设计思想

2.6 浏览文件

  • 根据文件名猜测文件功用,粗略看

2.7 选切入点

  • 从入口点切入,走一遍业务逻辑,了解设计思路

2.8 尝试添加功能或者修复bug

修改bug和添加功能是熟悉项目最好的方法。能做到时,基本熟悉这个项目的结构和逻辑了。

3 特殊方法

如何文档啥的没有,那就直接读代码。

  • 从入口处找到顶层功能类、功能函数
  • 往下找基类、子函数,了解基类、子函数功能(非必要,暂不抠细节)
  • 以此往复,理清功能模块位置和关系
  • 这个过程也变相是逆构UML
  • 最终理清代码

4 简单举例

扫地机器人的上位机软件项目

4.1 3W

  • What?
    上位机软件做什么的?
    ->控制机器人
  • How?
    上位机如何控制机器人?
    ->收发指令
  • Why?
    为什么这么实现?
    ->通用技术路线

4.2 核心

  • 指令定义
    数据格式
  • 指令管理
    文件操作、数据增删改查
  • 指令收发
    TCP/IP、消息首尾flag

4.3 设计模式

  • 根据业务逻辑采用相应的设计模式

5 注意点

  • 保证看代码时间,处理好主次矛盾是成功关键
  • 实事求是,确定工作目标

参考

1、C#怎么才能高效,快速的看懂别人写的项目?
2、快速熟悉项目代码
3、应该以一种怎样的思路阅读iOS项目代码?

展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 技术黑板 设计师: CSDN官方博客
应支付0元
点击重新获取
扫码支付

支付成功即可阅读