小程序开发文档规范

目录规范

1.目录概述

组件文件

所有组件相关文件统一放在components目录下。

图片文件

项目图片文件放置于根目录的images文件夹下,组件独有的图片放在当前组件images目录下

模型文件

模型文件主要用于编写各类业务模型。项目模型文件放置于根目录的models文件夹下,组件相关模型放置于components目录下的models文件夹中。

行为文件

行为文件放在所引用的组件目录下。


WXML规范

1.     WXML规范

wxml标签可以单独出现的情况,尽量单独出现,如<input />。

<input />

控制每行HTML的代码数量在50个字符以内,方便阅读浏览,多余的代码进行换行处理,标签所带属性每个属性间进行换行。

<v-music

wx:if="{{classic.type===200}}"

img="{{classic.img}}"

content="{{classic.content}}"

</v-music>

合理展现分离内容,不要使用内联样式。

<image class="tag"></image>


2.     注释规范

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

<view>...</view>

//导航栏

<view>...</view>

<view>...</view>

CSS规范

1.    CSS规范

在开发过程中rpx和px均可能用到,如通常情况下间距使用rpx,字体大小和边框等使用px,开发者根据实际情况而定。

width: 100rpx;

font-size: 14px;

CSS代码需有明显的代码缩进。每一个样式类之间空出一行。

.v-tag{

    width: 100%;

}

.v-container{

    width: 100%;

}

尽量使用简写属性,并且同一属性放置在一起,避免散乱。

/**使用简写属性**/

.v-image{

    margin: 0 auto;

}

/**同一属性放在一块**/

.v-tag{

    margin-left: 10rpx;

    margin-right: 10rpx

}

采用flex进行布局,禁止使用float以及vertical-align。

.container{

    disaplay: flex;

    flex-dirextion: row

}

2.     注释规范

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

/** 修改button默认的点击态样式类**/

.button-hover {

    background-color: red;

}

JS规范

1.     JS规范

命名规范

变量名以及函数名统一采用驼峰命名法,正常情况下函数名前缀需加上清晰的动词表示函数功能,私有函数或者属性以下划线开头表明。常量需用const 声明。

类的命名首字母需大写。

采用ES6 关键字let定义变量,尽量不使用var

//定义常量

const a = 1

//定义变量

let imageContent = res.data

//函数命名

getInfo:function(){

    return '';

}

//私有函数

_getInfo:function(){

    return '';

}

回调函数规范

回调函数统一使用Promise函数的方式进行编写,回调成功的参数统一为res,错误参数为err。

// promise 处理回调

let back = new Promise((resolve, reject) => {

    if (/* 异步操作成功 */){

        resolve(value);

    } else {

        reject(error);

    }

});

back.then((res) => {

      console.log('成功回调!', res);

    }).catch((err) => {

      console.log('失败回调!', error);

});

私有函数以及回调函数统一放置在生命周期函数后。

删除js文件中未用到的生命周期函数,保持代码的整洁。

Pages({

    data:{

    },

    onLoad:function(event){


    },

    _self:function(){

    }

})

每个函数之间用一个空行分离结构。

数据绑定变量定义规范

所有涉及到数据绑定的变量均需在data中初始化。禁止在不定义的情况下直接setData。

Pages({

    data:{

        id : null

    },

    onLoad:function(event){

        let id = event.target.dataset.id

        this.data.id = id

    }

})

点击事件规范

点击事件函数命名方式为 on + 事件名 或者业务名。

onLike: function(event){

}

组件规范

组件名命名规范

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

v 来源于法语 单词 ‘vent’ @林间有风

<v-movies />

触发事件规范

组件点击触发事件建议用冒号分隔开

<v-component-tag-name bind:myevent="onMyEvent" />

externalClasses命名规范

命名格式采用如下形式:v-class-{name},name可自行定义

v-class-icon


组件样式规范

所有组件样式均应采用类的写法,且命名必须以 v- 开头,不允许使用内联样式以及id样式

.v-container{

    disaplay: flex;

    flex-dirextion: row

}

标点规范

JS语句无需以分号结束,统一省略分号

JS中一致使用反引号 ``或单引号' ' , 不使用双引号。

WXML、CSS、JSON中均应使用双引号。

CSS属性中冒号中后面用一个空格分隔开。

————————————————

原文链接:https://blog.csdn.net/qq_29920751/article/details/87623435

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容

  • 目录概述 基础规范页面、样式、行为、规范,不用首屏加载的尽量分包 图片文件项目图片文件放置于根目录的images文...
    Cactus_b245阅读 2,122评论 0 3
  • 一、目录概述 基础规范 页面、样式、行为、规范,不用首屏加载的尽量分包 图片文件 项目图片文件放置于根目录的ima...
    风了个1阅读 3,379评论 0 0
  • 自微信6.5.3版本开始,小程序正式跟大家见面了。最近利用业余时间做了个小程序,命名“养车记账本”。作为IT狗,经...
    第九程序官方阅读 1,865评论 3 19
  • 目录: 前言 准备工作 申请资源 域名(申请、解析、备案) 创建微信小程序服务器 腾讯云实名认证 SSL证书 小程...
    信息风暴阅读 597评论 0 1
  • 在使用过程中想到一点记录一点,只是个人感想。 支付宝小程序的底层应该是React Native的,但是,小程序界面...
    勇往直前888阅读 21,046评论 3 9