微信/支付宝小程序 开发规范文档

为提高团队开发效率和代码质量,减少不必要的低级的bug产生,特制订此规范,请大家严格遵守开发规范。(微信/支付宝小程序通用)

1.开发工具:

统一开发工具能够提高开发效率,建议使用webstorm开发,此IDE有代码补全、重复命名和声明未使用等错误提示。

2.项目结构:

  • 项目根目录下创建pages目录,用于存放页面
  • pages目录下创建components目录,用于存放自定义组件
  • pages目录下创建ExternalPages和ExternalPagesPorsche目录,用于展示webview页面
  • pages目录下创建home目录,用于首页业务页面
  • pages目录下创建login目录,用于登录业务页面
  • pages目录下创建my目录,用于我的业务页面
  • pages目录下创建order目录,用于订单业务页面
  • 项目根目录下创建lib目录,用于存放三方类库
  • 项目根目录下创建utils目录,用于存放工具类
  • 项目根目录下创建image目录,用于存放静态图片资源

3.代码书写规范:

  • 代码缩进4个空格
  • 每个函数体之间保留一个空行
  • 每给函数体需要写明注释:
/**
 * @desc 此函数具体实现功能描述
 * @param service int 参数名/数据类型/参数描述
 * @return {week: string, month: string, year: number, time: string, day: string} 返回值
 */
  • 函数体内注释写法:
function getTakeTime(service) {
    // TODO 设置当前时间加整备时长为当前默认取车时间
    // do something
    // TODO 获取取车时间分钟 格式化取车时间为15分钟每段
    // do something
    // TODO 如果取车时间对象不为空&&取车时间比当前时间+整备时间大 默认还是取车时间
    // do something
    return {}
}
  • 变量命名和声明规范

命名为驼峰命名法,首字母小写
声明变量必须根据数据类型进行设置默认值

let serviceTime = “”
let serviceTime = 0
let serviceTime = false
let serviceTime = {
    take: "",
    give: ""
}
  • 文件夹和文件命名规范

命名为驼峰命名法,首字母小写
字母小写 多词-多词

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

推荐阅读更多精彩内容