微信小程序开发规范文档

项目名

项目名要求使用语义清晰,简短,统一使用英文小写,并且使用隔开,后缀要加以区分是小程序项目,例如:、。

项目结构

页面目录

1. 由历史原因和个人习惯导致目录命名不统一,语义不清晰,不同成员在维护时难以快速识别。

目录命名应遵循以下规范:

尽量简短

采用英文小写方式

单词间以下划线连接

英文语义需与当前目录实现的功能保持一致

如有复数,应采用复数命名

不应该出现数字和除下划线以外的特殊符

示例:

2. 小程序规定,一个页面由,,,四个文件组成。为了方便者减少配置项,描述页面的四个文件必须具有相同的路径与文件名。

示例:

3. 非公共组件和资源可放入对应页面的的文件下的和里。

示例:

1. 强类型检查,使用代替

2. 变量

给变量命名时,应该要使变量名具有代表意图的象征,使人易于搜索并且容易理解。

不要在变量名中增加没必要的额外单词

不要强行记忆变量的上下文

变量名不要加上下文重复的单词

3. 函数

统一使用省略函数标识符的写法

函数名应该是动词或者短语,代表某种行为,描述它们在做什么

避免使用大量的参数,理想的情况就是使用两个或者更少的参数。参数越少,测试就越容易

函数应该使用默认参数,而不是条件语句

(至于为什么,在阮一峰6入门-函数参数的默认值中有说明)

一个函数应该做一件事,避免在一个函数中执行多个操作。

使用设置默认对象

不要使用标记作为参数,因为它们告诉你该函数正在做的比它应该做的更多。

不要污染全局变量。如果需要扩展现有对象,请使用6类和继承,而不是在现有对象的原型链上创建函数

4. 条件语句

避免负面条件

使用条件语句尽量短点。这可能是微不足道的,但值得一提。此方法仅用于布尔值,并且如果您确定该值不是未定义的或为

尽可能避免分支,请改用多态和继承。

5. 6类

类是中的新语法糖,跟原型对象一样,只是它现在起来不同,你应该更喜欢它们而不是5的使用构造函数。

使用方法链接,许多库如和都使用这种模式。因此,您的代码将不那么冗长。在你的类中,只需在每个函数的末尾返回它,你就可以将更多的类方法链接到它上面。

6、常规的避免

一般来说,尽量不要重复自己,就是说不应该编写重复的代码,也不要在你身后留下尾巴,比如未使用的函数和死代码。

由于各种原因,你最终可能会有重复的代码。比如,你可能有两个略有不同的东西,它们有许多共同之处,有时期限不足的迫使你创建包含几乎同样代码的单独函数。

关于死代码,这正如它的名字。它没有做任何事情,因为在某些阶段,你已经决定不再用它,您应该在代码库中搜索这些不需要的函数和代码块并删除。 我建议你,一旦你决定不再需要它,就马上删除它, 以防你以后可能会忘记它的用途。

(以上规范大量参考)

1. 注释

基本语法

注释代码以开始,以结束

注释不能嵌套

示例

注释内容

对于一般性注解,书写简单的短语;对于较长的注解,书写完整的句子。

注释位置

注释应该写在被注释代码块的上一行,或者单行注释时放在单行后面,不要放在代码块的后

注释格式

注释内容的第一个字符和最后一个字符皆为一个空格字符

单行注释

模块注释

2. 代码规范

代码风格

代码格式化

样式书写一般有两种:一种是紧凑格式 ()

一种是展开格式()

约定:统一使用展开式书写样式。

代码大小写

样式选择器,属性名,属性值关键字全部使用小写字母书写,属性字符串允许使用大小写。

选择器

尽量少用通用选择器

不使用 选择器

不使用无具体语义定义的标签选择器

代码缩进

统一使用两个空格进行代码缩进,使得各编辑器表现一致(各编辑器有相关配置)

每个属性末尾都要加分;

代码易读性

左括与类名之间一个空格,冒与属性值之间一个空格

逗分隔的取值,逗之后一个空格

为单个选择器或新申明开启新行

颜色值 中不需有空格,且取值不要带有不必要的 0

属性值十六进制数值能用简写的尽量用简写

不要为 指明单位

属性值引

属性值需要用到引时,统一使用单引

属性书写顺序

建议遵循以下顺序:

布局定位属性: / / / / /

自身属性: / / / / /

文本属性: / / - / - / - / - / -

其他属性(3): / / - / - / - / :- …

官方属性顺序推荐

3浏览器私有前缀写法

3 浏览器私有前缀在前,标准前缀在后

1. 选择器()命名规范

选择器命名基本规则

以字母开头,全部字母小写

尽量简短、明确

单个名字如果由多个词组成,单词间以下划线_连接

层级关系以中划线-连接

继承式命名

为了保证我们设计的样式既能重复利用,又能避免冲突。我们采用继承式来给样式命名。

每个页面一般都可以分成几个模块,我们把每个模块最外层的名作为祖先,模块内部的样式名用祖先名作为前 缀,它们以中划线-连接。(通过这种方式来表示样式的作用域

在页面结构里,模块内部可以有子模块,子模块下面可以有孙子模块,以此类推。样式命名也按这个层级。

缩写

当页面结构复杂,层级过多,样式名的前缀就会太多太长,我们需要对前缀进行缩写。

当样式名的前缀太多(一般超过2个)或太长,我们把每两个前缀作为一组,取每个前缀的第一个字母合在一起组成新的前缀,前缀与前缀或样式之间以中划线-连接。缩写时要保证新的前缀具有唯一性和可辨识性。

常用命名推荐

2. 注释规范

注释

代码是由人编写并维护的,我们要尽可能保证写的代码能够自描述、注释良好并且易于他人理解。好的注释能够传达上下文关系和代码目的。

注释代码以结尾。

标准写法

错误写法

单行注释

一般用于简单的描述,如状态描述,属性描述等。书写时应遵循以下规范:

注释内容前后各一个空格字符

注释位于注释代码上面

单独占一行

推荐:

不推荐:

代码块注释

一般用于描述某一块代码的名称或开始,结束位置。书写时应该遵循以下规范

注释内容前后各一个空格字符

表示代码块开始, 表示代码块结束

代码块与代码块之间相隔一行

推荐:

不推荐:

嵌套代码块注释

用于代码块内嵌套的代码块的注释,注释格式由

改为

推荐:

不推荐:

3. 代码规范

标签

小程序视图层基于小程序框架为者提供的一系列基础组件,这些基础组件通常以双标签或单标签的形式使用。

双标签包括起始标签,结止标签和属性,内容在这两个标签之内

单标签只有一个,有属性,没有内容

小程序规定,标签名有多个词时,词之间以连接符-连接。

编码时要遵循标签的语义,要尽量使用最少的标签并保持最小的复杂度。

代码大小写

所有标签和属性,大部分属性值统一使用小写

推荐:

不推荐:

标签的闭合

在小程序里,有些组件必须写成双标签,如视图容器类组件;有些组件可以写成单标签,如媒体类组件;但在小 程序运行时,它们都会解析成双标签。

在小程序里,所有的标签一旦使用都必须被闭合,使用标签不闭合会报错,导致程序无法运行。

正确写法:

错误写法:

所有具有开始标签和结束标签的元素都要写上起止标签,某些可以省略结束标签的亦都要写上

推荐写法:

不推荐:

标签属性

标签属性值使用双引语法

属性值可能写上的都写上

推荐:

不推荐:

谨慎使用属性

属性具有唯一性,可以用来标识具体组件,应避免在样式上使用属性(选择器)

属性书写顺序

标签属性应按照以下顺序依次排列,以确保代码的可读性

特殊字符

正常情况下的小程序里,文本和字符实体不能混合出现。

如需使用字符实体,需使用组件并设置属性,并且目前仅可解析 & '    ,参考文档

正确用法

错误用法

特殊符使用输入法输入即可

连续空格的使用

需使用组件并设置属性

无属性的内多个连续空格最终只显示一个

非组件设置属性不会有连续空格的效果

正确写法

无效写法

代码缩进

统一使用4个空格字符进行代码缩进

代码嵌套

编写代码时,需要保证页面结构稳固,同时需要避免多余的父元素,减少嵌套。

推荐写法

不推荐写法

块级标签的起止标签各占一行,行内标签的起止标签一般写在一行内,如果标签内容过多,起止标签则各占一行。

推荐写法

不推荐写法

© 版权声明
THE END
分享