Team间的一些协作准则总结
在实际项目开发中,团队的配合总是必不可免,一个项目的完成仅仅前端间的协作就是在平常不过的事,而这样也常常导致各种各样的,比如类名的重用等等,针对这些问题有个良好的习惯对我们团队间的协作讲会带来很多便利,在这里写下些以方便往后扩展完善:
一、私有模块文件名以下划线私有变量名命名方式开头;(这样可以方便模块识别模块便于管理)
二、模块板块class以板块名为前缀中划线断开,子类通过父类连加模式写比如.mod-sya .tab定义一个tab,这样当有多个tab类时彼此间不会产生影响也方便js的处理;(便于排查模块间的错误和解耦)
三、js交互板块ID以大写J加下划线开头命名作为钩子连接,此ID禁止定义样式;
四、font-weight统一用 500代替 normal, 用 700代替 bold
五、CSS3 书写规范:浏览器私有写法在前,标准写法在后
六、不强制书写顺序。但我们应该养成良好的习惯,让看代码的人更易理解。易读对于团队协作来说是非常重要的:框架为先,细节次之比如写一个浮动容器的样式,我们应该先让这个容器的框架被渲染出来,让大家看到基本的网站框架。然后再再去渲染容器里面的内容。最终呈现给用户. 通常像 color font padding 之类的,写在后面。(注意css间因果顺序)
七、Background 为了避免网速缓慢导致CSS已经 加载,而图片仍未加载完成或图片服务器挂掉时文本不可见请尽量使用加上CSS定义的背景颜色
八、统一命名规范,对于通用板块用通用类名放入common公用样式表中,方便调用,而个人模块这通过模块名加后缀组成(因为某个模块可能存在N张不同的展示效果,通过后缀可以方便的加以区分)
九、最忌讳的一点就是一定要避免全局样式变量的定义,这样的习惯一定要养成,如果某个模块需要一个公用样式和变量,定义在模块内和模块自身即可。
-------------------------------
目前整理的只有这些往后空了在慢慢总结