青青草原--团队作业6:代码规范

Posted 2021-06-02 青青草原fzu

这个作业属于哪个课程	2021春软件工程实践S班 (福州大学)
这个作业要求在哪里	团队作业六——beta冲刺+事后诸葛亮
团队名称	青青草原
这个作业的目标	完成beta冲刺
其他参考文献	无

目录

• 一、代码规范
  • 代码规范地址
  • .wxml代码规范
  • .wxss规范
  • .js代码规范
  • 文件名规范
  • 文件规范

---

一、代码规范

代码规范地址

• 仓库地址

.wxml代码规范

1. 缩进：以空格代替tab,1个缩进=2个空格

   <view class="list-item" bindtap="testFunction">
     <text>测试云函数</text><!--缩进两个空格-->
   </view>
   

2. 标签属性控制顺序逻辑代码>标签属性>自定义数据值>class>style

   1. 逻辑代码包括不限于：wx:if,wx:for,wx:else,wx:hidden，wx:for-item等…超过一行时使用单独的
   2. 标签属性举例：标签的scroll-y属性
   3. 自定义数据值举例：data-index="{{xxx}}" ，data-id="{yyyy}:这种以data-开头的
   4. 自定义数据值个数尽量不超过3个，对应的值总长度不超过12个字符，标识不超过20

   <view>
     <view wx:for="{{list}}"
           wx:key="id"
           id="sth"
           attr="aaaa"
           data-type="sth">
       {{item.name}}
     </view>
   </view>
   

3. wx:for循环和wx:if嵌套尽量不超过2层，如果有嵌套，指定层级item和index值，如 wx:for-item=“item1” wx:for-index=“index1”。超过2层嵌套时请在wxs里单独处理或者在js里预处理数据。

4. 相关key一律小写，value以小驼峰方式命名，比如 data-canuse="{{canUse}}"

5. 自定义组件命名统一以cp开头，如cp-mycomponents

6. 尽量使用catch代替bind绑定，比如catchtouchmove代替bindtouchmove，阻止冒泡时很多情况下可以提升性能

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

.wxss规范

1. 使用选择器时，命名比较短的词汇或者缩写的不允许直接定义样式。如下：

   .hd,.bd,.td{};
   

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

   .recommend-mod .hd{   }
   

2. 多选择器规则之间建议换行，即当样式针对多个选择器时每个选择器占一行。如下：

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

3. 避免使用低效的选择器。如下：

   body > * {…};
   ul > li > a {…};
   #footer > h3 {…};
   

4. 尺寸单位统一使用 rpx

.js代码规范

1. 强类型检查:=== 代替 ==, !==代替!=

2. 相关命名规则

   1. 内部变量以及方法/函数命名：小驼峰命名法，如

      let orderIndex=1;
      

   2. 事件处理函数命名：handle起头

      handleTapItem(e){……}
      

   3. 重写mix方法命名：下划线+小驼峰

   4. 点击事件命名：tap+大驼峰

   5. 类命名：大驼峰命名法，如 Class Student{}

   6. USER_OPENID:wx.setStorageSync(‘USER_OPENID’, res.result.openid);

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

   8. 不要在名字中增加没必要额外的单词，比如name要写成theName

   9. 命名时不要加上下文重复的单词

3. 优化规范

   1. 变量命名采用小驼峰法

   2. 用空格代替tab

   3. 字符串采用单引号

   4. 语句结束带分号

   5. 对象最后一个属性结束带逗号

   6. 采用字符串模板处理字符串拼接

   7. 优先选择箭头函数

   8. 变量声明使用let

      let params;
      

   9. 常量命名采用大写

   10. 优先选择解构赋值

   11. 对象初始化优先选择简写方式

   12. 循环遍历优先选择forEach

   13. 优先选择使用const修饰变量

   14. 运算符前后加空格

       let a = b + c;
       

   15. 其他，使用Shift+Alt+F快捷键可以统一代码风格，可以满足需求

文件名规范

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

文件规范

1. 图片规范：命名应用小写英文、数字、_组合，便于团队其他成员理解。
   图片格式仅限于gif、png、jpg等，单张图片大小最好不要超过100K。