最新消息:

多人协作规范

规范 banban 259浏览 0评论

任务分配

在进行多人协作开发的时候,每个人都要知道自己负责的部分,也要了解其他人负责的部分,这样是为了避免多人维护同样的代码带来的问题。在进行多页面开发的过程中,必然存在一些公共的部分,在我理解来看,我把那个公共部分分为全局公用的部分和局部公共的部分,全局使用的部分,包括在网页的reset,common meta部分,公共头尾部分以及公共js部分,这部分代码应该放在inc片段里面这common.js里面,由一个人负责写和维护。另外一部分为局部公共部分,这一部分可能是开发某个人负责的页面或者他和其他同事负责页面存在公共部分,这时候这部分代码就应该抽离出来,封装为一个公共js文件或者inc片段,可采用命名空间进行命名,如:common-inpage.js等等。

公共模块的规范

分配好了全局公共模块和局部公共模块之后,当然会出现一个问题,可能你引入了公共模块的js后,会出现页面变量方法名字冲突问题,导致一些问题发生二以及代码可读性问题,建议写公共模块时候可以采用模块模式进行书写,暴露一个接口即可。详情见 https://zhuanlan.zhihu.com/p/22890374 ,推荐使用揭示模块模式进行一些小段代码的封装,一是可读性,二是减少污染全局变量及代码冲突,进行公共模块书写的时候,尽量保证代码的可读性比较强。

降低代码耦合性

我们大家写代码,尽量写的优美,尽量减少重复代码部分及可读性。可从以下几个方面入手。

1. 解耦html和js,少写行间js,特殊情况除外(如:点击流)

2. 解耦css和js,需要js添加的样式,建议用js的className进行添加,在css中进行定义

3. 解耦事件处理程序和应用逻辑,事件处理程序内不应该放过多应用逻辑,这时候应该将应用逻辑抽离单独封装一个函数

4. 多个应用场景函数应该抽离出来。例如初始化调用,屏幕大小改变又要进行调用

5. 抽离配置参数,应该将代码运行的配置参数抽离出来,更改配置时候就简单很多

开发过程

进行分配和公共模块的开发,和个人的开发部分,开发过程中,遇到公共模块出错的时候,应该找到开发公共模块的人进行修改,书写公共模块的注意在定义好公共模块之后不要轻易修改公共模块部分,可进行功能添加和添加模块,没有书写公共模块的不要修改不属于自己定义的模块变量和方法。

 

持续更新中……

转载请注明:文档库 » 多人协作规范

与本文相关的文章

  • 暂无相关文章!
发表我的评论
取消评论
表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址