天天看点

思考:服务器设计文档的重要性及其如何编写

1)背景

我们在开发功能过程中,有时是完全自己设计,有时是在别人代码基础上设计,有时候不知道大家有没有一种感觉:连自己设计的代码,自己都说不清楚。我思考之后,总结了下,这个问题其实是因为:自己没有从头梳理一遍。为了解决这个问题,才有个这个文档设计doc的编写。

开发都很忙,那么我们何时编写这个doc呢? 我想应该是在功能开发完成后,因为此时,我们才需要梳理自己的思路。

2)如何编写?

1.业务理解

这个是用自己的语言描述下对这个开发过的模块的理解及其注意事项。

2.消息号

由于服务器主要是接收客户端的请求进行处理的,因此,弄清楚每个消息号中每一步的实现很重要。

消息号其实就是客户端和服务器端的交互逻辑。

3.涉及到的类

除了消息号,服务器逻辑必然也有一个从头到位的执行流程,如:玩家登录进行初始化,定时器的初始化,这些东西并不在消息号中体现,但是却是这个模块的一部分。因此涉及到的类其实就是从头的一次梳理。