微信小程序开发规范文档-注意事项

Posted 2021-03-01 jianxian

1. 一个页面的数据如果需要被其它页面修改，则把这个页面的数据放入storage里。

2. 目录结构符号

   └ ┌ ┘ ┐ ┤ ├ ┴ ┬ ┼ │ ─

JS模块引入请使用import关键字，而非require，WXML引入模板用标签，WXSS使用@import语法，三者统一

所有方法和变量名称都使用小写camel模式，一般是动词+名词形式，尽量不要超过5个单词，如：getList，setBackImage

所有用到的常量的地方都使用全大写，下划线分隔的形式，如：EGG_CHE

使用this转换的地方，统一使用that，如：let that = this; 尽量使用箭头函数，可保留this指向

所有自定义方法（onLoad，onShow等系统方法除外）必须使用规范注释语法进行注释

在page和model里定义方法的时候，直接使用getList(){} 即可，中间可以不用加function关键字

代码精简

小程序声明周期函数里（onLoad，onReady，onShow，onHide，onUnload等）不要直接写复杂业务逻辑，复杂业务逻辑独立成方法，这里只负责方法调用。

modal

所有数据处理必须封装到model里面，包括url地址，参数格式化，返回结果格式化都放到model里面，在page里使用的时候，基本不用做过多数据处理，一般都直接setData皆可,model规范请参考前面的说明。

公用代码抽取

如果1个功能在超过一个地方出现，那请实现为公用组件，组件实现请参考前面的说明。

在WXML模板里，如果同时有2个循环中都使用到了同样的代码片段，请使用template的方式定义，然后直接使用即可，不能重复写.

空数据处理

所有地方都需要有对接口返回空数据的处理，界面上要有相应的提示和引导。

其它的可以定义规范的loading，成功失败提示等，这里不多说了.