今天笔者和大家聊一聊在项目交接中遇到的问题
项目交接这种事是不可避免的,一个完整、完善的项目在交接的时候会省不少心,反之就让人抓狂了,尤其是代码交接部分,先不说代码是否写的巧妙,只要命名符合规范,思路清晰,有完善的文档,后续的维护是很轻松的,但是那种想起哪里写哪里,毫无逻辑可言的工程就像一坨屎(虽然笔者写的也自认为是屎),所以接手这种工程,再继续维护就好像:在一坨奇臭无比的一坨屎里面分析、分类、挑选这个人昨天都吃了什么,所以为了尽可能的避免这种狗屎工程,笔者谈一谈在交接的时候交接人需要准备的东西。
以Unity项目为例
- 所有字段、属性、方法必须有XML注释
- 命名必须符合命名规范:详见:Unity 之命名规范(一)Unity之命名规范(二)
- 每一个类有交代设计思路和负责的功能作用,详见:Unity 之命名规范(一)中的评论说明
- 代码(C#)缩进格式详见:Unity 之命名规范(一)Unity之命名规范(二)
- 所负责编写系统的整体设计思路文档
- 所编写系统的资源(程序、美术)替换详细文档(包括字段设置,参数设置,位置注意事项,命名方式等)
- 随机抽取一套资源进行资源替换测试(按照资源替换文档进行逐步操作验证)
- 测试人员拿到相应设计系统测试30-60分钟,保证无BUG
- 所负责编写系统的用的到技术、难点及说明