天天看點

《衆妙之門——JavaScript與jQuery技術精粹》——2.4 進行代碼複查的人員需要提供的資訊

本節書摘來自異步社群《衆妙之門——javascript與jquery技術精粹》一書中的第2章,第2.4節,作者: 【德】smashing magazine譯者: 吳達茄 芮鵬飛 更多章節内容可以通路雲栖社群“異步社群”公衆号檢視。

google前開發人員jonathan betz曾經提到過對别人進行代碼複查時應該提供的六樣東西:

1.正确性

代碼能實作所有它聲明的功能嗎?

2.複雜性

代碼是否直接完成了其功能?

3.一緻性

它是否與目标一緻?

4.可維護性

團隊内其他人員付出一定合理水準的努力時是否可以較容易地拓展代碼?

5.可擴縮性

代碼是否是按照對100個或者10000個使用者同樣工作的原則來書寫的?它是最優的嗎?

6.風格

代碼是否按某一特定風格編寫的(最好是按照團隊統一的風格)?

我贊同以上六點,并将它擴充成複查者在實際操作中可以遵循的行動手冊。是以,複查者應該做到以下幾點:

. 提供清晰的評論、依據并保持良好的溝通。

. 提出可實作的不足之處(不要批評過度)。

. 指出為什麼某種方法不推薦,如果可能的話,給出部落格、文章、要點、說明、mdn頁和jspe rf測試來支援你的觀點。

. 給出替代解決方案,或是用一個單獨的可運作格式,或是通過fork整合在代碼中,友善開發者清晰地看到它們錯誤的地方。

. 首先關注解決方案,其次看程式設計風格。對于程式設計風格的建議可以放在複查的後面,但是在關注這個之前首先要找出根本的問題。

. 複查要求外的部分,這完全由複查者自己決定,但是如果我發現開發者其他方面的問題,我一般會建議他們如何改進。到目前為止我還沒收到過關于這方面的抱怨,是以我認為這并不是一件壞事。

繼續閱讀