天天看點

思考:伺服器設計文檔的重要性及其如何編寫

1)背景

我們在開發功能過程中,有時是完全自己設計,有時是在别人代碼基礎上設計,有時候不知道大家有沒有一種感覺:連自己設計的代碼,自己都說不清楚。我思考之後,總結了下,這個問題其實是因為:自己沒有從頭梳理一遍。為了解決這個問題,才有個這個文檔設計doc的編寫。

開發都很忙,那麼我們何時編寫這個doc呢? 我想應該是在功能開發完成後,因為此時,我們才需要梳理自己的思路。

2)如何編寫?

1.業務了解

這個是用自己的語言描述下對這個開發過的子產品的了解及其注意事項。

2.消息号

由于伺服器主要是接收用戶端的請求進行處理的,是以,弄清楚每個消息号中每一步的實作很重要。

消息号其實就是用戶端和伺服器端的互動邏輯。

3.涉及到的類

除了消息号,伺服器邏輯必然也有一個從頭到位的執行流程,如:玩家登入進行初始化,定時器的初始化,這些東西并不在消息号中展現,但是卻是這個子產品的一部分。是以涉及到的類其實就是從頭的一次梳理。