前言
本文主要根据自身经验和前端开发规范总结的微信小程序开发规范文档,适用于多人团队协同开发和个人开发小程序。
主体
统一团队的编码规范,可以统一不同开发者编码过程中相对主观化的代码风格,有助于代码的维护和迭代。
文档初期会存在不完善的地方,不可避免地会有错误和遗漏之处,发现请积极指正。文档会随着开发者经验的积累和实践进行迭代,由团队所有小程序开发者共同维护。
以下规范是基本约定的内容:
-
微信开发者工具配置
-
建议开发者如何配置开发者工具。规范里规定的大部分格式都可以使用微信开发者工具自动格式化功能实现。
-
目录规范:规定了目录的层级关系,目录命名等。
-
WXML规范:规定了WXML代码和注释写法。
-
WXSS规范:规定了WXSS代码和注释写法。
-
WXS规范:未制定
-
JavaScript规范:规定了JavaScript代码的格式,语言,注释,数据交互等写法。
-
图标/图片/视频规范:未制定
-
模板/组件规范:未制定
-
版本控制Git使用规范:未制定