Home » Flash相关 » 技术人生 » 文档管理对于代码质量控制的好处

文档管理对于代码质量控制的好处

从墨麟《风云无双》离职后,加入我当前所在的创业团队差不多快一年了,新项目是一款西游类的ARPG游戏,眼看就快要上线了。
接下来的时间,除了继续完善引擎和工具,打算不定期的写写博客,把在研发过程遇到一些坑和填坑经验给总结沉淀下来。

最近正在升级动画资源文件格式。重新设计了一下资源格式文件结构,与旧版SPT格式(一种我设计文件格式)相比,新版SPT2资源格式将极大的降低资源解压和解析的计算消耗,而且可以减少文件大小5~20%。
趁着工具正在对大规模的动画资源文件进行SPT格式转SPT2格式的功夫,我想跟大家谈谈关于代码质量控制一些事情。
代码质量控制,看上去是一个管理学的命题,本质上却是一个技术命题。

任何脱离对业务技术了解这个基础的管理,都是瞎扯蛋。

以上装逼扯淡完毕,下面……

下面我们接着扯淡装逼。

代码质量控制主要从以下两个方面着手:

1、文档管理(Document Management)

2、代码查看(Code Review)

3、性能测试(Performance Test)

一、文档管理

这里文档主要指前后端数据通信协议文档。

曾经有句话一直激励着我:“一个优秀的程序员与一般的程序员之间有个非常重要的区别,那就是优秀程序员的代码是写出来的,而一般程序员的代码是调试出来的。”

在我们游戏研发过程中,这句话其实很容易得到验证,牛逼程序员代码交付一般都是一步到位,很少纰漏。而一般的程序员,往往反复修改,几经折腾才能交付。

经过对自己的反思,我发现要避免“代码是调试出来的(Bug必须少)”这样浪费成本的最佳方法,就是规范文档。

文档规范的好处大致有以下几点:

1、文档编写的过程,实际上就是一个自我检查的过程。在写文档的过程中,你可能会发现代码逻辑的纰漏,设计上的不合理,从而减少BUG。

2、良好的协议文档可以减少团队的沟通成本,减少合作方因为不理解,而过来询问的次数,从而减少自己被打扰的次数,让自己获得更多的时间和专注。

3、清晰的文档可以减少队友因为误会而出错的可能,整个团队开发效率都会得到提升。

4、文档记录了自己的设计思路,对于公司和员工来说,都会是一笔难得的经验财富继承。

5、不注重文档管理和规范,实际上就是一种典型的“用战术上的勤奋去弥补战略上的懒惰”的行为。

好文档一般具有以下几个特征:

1、时效性  如果代码有改动,及时更新文档。

2、结构化  有清晰和固定的结构,保持开发节奏稳定向前推进的惯性。

3、可索引  没有目录索引的文档,就好比一部《新华字典》被人撕掉了前面的索引。

二、代码查看

主要是主程,偶尔抽查一下提交上来的代码,一般新人需要特别关照。重点还是要在第三点的性能测试环节。

这里略过。

三、性能测试

scout

打开Scout,打开游戏,跑上20-30分钟,或者挂机十多个小时。通过Scout记录的数据,可以轻松发现是否存在内存泄露,性能瓶颈在哪?从而可以定位泄露BUG以及可优化的代码。这是个技术活,以后我会专门针对《利用Scout优化Flash游戏性能》这类话题发布自己的一些经验和心得。

通过对游戏性能的观察,可以及时发现团队开发过程中需要避免的坑,向团队发出预警提示,或者修改引擎代码,从设计上避免遭遇“性能杀手”。

    分享到: