【小程序】代码书写规范

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_33237207/article/details/88943455

1、规范目的

使开发流程更加规范化。

 

2、通用规范

* 尽量使用完整的英文描述符

* 采用适用于相关领域的术语

* 采用大小写混合使名字可读

* 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一

* 避免使用长的名字(小于 15 个字母是个好主意)

* 避免使用类似的名字,或者仅仅是大小写不同的名字

* 避免使用下划线(除静态常量等)

 * 注释应该增加代码的清晰度

* 保持注释的简洁

* 在写代码之前写注释

 

3、文件名规范

pages目录下文件名用英文单词命名,多个单词用驼峰命名法,以小写字母开头,尽量不包含数字或者其他字符。

 

4、.wxml文件---页面代码规范

A、编码均遵循`XHTML`标准,标签、属性、id命名由小写英文、数字和‘_’组成,且所有标签必须闭合,属性值必须用双引号`""`。

B、避免使用中文拼音尽量简易并要求语义化。

C、尽可能减少标签嵌套,做到代码层级清晰。

D、尽量避免在标签上直接写样式。

 

5、.wxss文件---页面代码规范

A、使用选择器时,命名比较短的词汇或者缩写的不允许直接定义样式。如下:

.hd,.bd,.td{};

可用上级节点进行限定。如下:

.recommend-mod .hd{   }

B、多选择器规则之间建议换行,即当样式针对多个选择器时每个选择器占一行。如下:

button.btn,
input.btn,
input[type="button"] {…};

C、使用z-index属性尽量z-index的值不要超过150(通用组的除外),页面中的元素内容的z-index不能超过10,(提示框等模块除外但维持在150以下),不允许直接使用(999~9999)之间大值。

D、避免使用低效的选择器。如下:

body > * {…};

ul > li > a {…};

#footer > h3 {…};

 

6、.js文件---页面代码规范

A、函数名前必须注释此函数的参数意义,以及该函数的用途。

B、if、while、for、do语句的执行体用"{}"括起来,"{}"格式如下:

if (a==1) {
    //代码
};

C、避免额外的逗号。如下:

var arr = [1,2,3,];

D、长语句可考虑断行,即一行显示不下,可分行显示。

E、使用严格的条件判断符。用===代替==,用!==代替!=,避免掉入==造成的陷阱 。

在==时,则会有一些让人难以理解的陷阱:

<script>
    var undefined;

    console.log(undefined == null); // true

    console.log(1 == true); //true

    console.log(2 == true); // false

    console.log(0 == false); // true

    console.log(0 == ''); // true

    console.log(NaN == NaN);// false

    console.log([] == false); // true

    console.log([] == ![]); // true
</script>

F、下面类型的对象不建议用new构造。

new Number

new String

new Boolean

new Object //用{}代替

new Array //用[]代替

 

7、图片规范

命名应用小写英文、数字、_组合,便于团队其他成员理解。

图片格式仅限于gif、png、jpg等,单张图片大小最好不要超过100K。

猜你喜欢

转载自blog.csdn.net/qq_33237207/article/details/88943455