代码规范

WXML规范

1. WXML规范

wxml标签可以单独出现的情况,尽量单独出现。
控制每行HTML的代码数量在50个字符以内,方便阅读浏览,多余的代码进行换行处理,标签所带属性每个属性间进行换行。
合理展现分离内容,不要使用内联样式。

2. 注释规范

除组件外的其他块级元素,均需注释出其功能,并在其上下空出一行与其他代码进行区分。

WXSS规范

1.wxss 页面可使用快捷键真理代码(Shift+Alt+F)

整理后代码有明显的代码缩进,对齐。每一个样式类之间空出一行;

2.在开发过程中rpx和px均可能用到,

如通常情况下间距使用rpx,
字体大小和边框等使用px,开发者根据实际情况而定;

3.同一块的样式属性(如 .order-title 和 .order-image)放在一块;

4.wxss样式之间用块状注释。请勿在代码后面直接注释。

CSS规范

1. CSS规范

在开发过程中rpx和px均可能用到,如通常情况下间距使用rpx,字体大小和边框等使用px,开发者根据实际情况而定。
CSS代码需有明显的代码缩进。每一个样式类之间空出一行。
尽量使用简写属性,并且同一属性放置在一起,避免散乱。

2. 注释规范

成组的wxss规则之间用块状注释。请勿在代码后面直接注释。

JS规范

1.删除js文件中未用到的生命周期函数,保持代码的整洁
2.右上角不要分享的页面,删除JS文件中该方法onShareAppMessage:function()
3.采用ES6 关键字let定义变量,尽量不使用var
4.所有涉及到数据绑定的变量均需在data中初始化,禁止在不定义的情况下直接setData
5.变量名以及函数名统一采用驼峰命名法(或下划线分割)
6.正常情况下函数名前缀需加上清晰的动词表示函数功能(如getOderList)
7.点击事件函数命名方式为 on + 事件名 或者业务名
8.JS语句无需以分号结束,统一省略分号
9.JS中一致使用单引号' ' , WXML中一致使用双引号" "
10.变量名以及函数名统一采用驼峰命名法,正常情况下函数名前缀需加上清晰的动词表示函数功能,私有函数或者属性以下划线开头表明。常量需用const 声明。
11.类的命名首字母需大写。
12.采用ES6 关键字let定义变量,尽量不使用var

组件规范

组件名命名规范

组件在使用时命名以 “v-”为开头的组件名,若组件名称为多个单词名拼接而成,采用 ' - ' 连接。组件标签在page页面使用时推荐使用单闭合标签(此条约束对于包含有slot的组件无效)

标点规范

1.JS语句无需以分号结束,统一省略分号
2.JS中一致使用反引号 ``或单引号' ' , 不使用双引号。
3.WXML、CSS、JSON中均应使用双引号。
4.CSS属性中冒号中后面用一个空格分隔开。
5.执行一致的缩进(4个空格)
6.执行一致的换行样式('unix')

通用规范

1.尽量使用完整的英文描述符
2.采用适用于相关领域的术语
3.采用大小写混合使名字可读
4.尽量少用缩写或拼音
5.避免使用长的名字
6.避免使用类似的名字
7.保持注释的简洁
8.在写代码之前写注释,方便其他成员看懂

posted @ 2020-05-09 21:59  用心聚落步  阅读(145)  评论(0编辑  收藏  举报