摩天脆脆冰淇淋队 ——代码规范与冲刺计划
这个作业属于哪个课程 至诚软工实践F班 - 福州大学至诚学院 - 班级博客 - 博客园 (cnblogs.com)
这个作业要求在哪里 第五次团队作业：项目冲刺
这个作业的目标 完成代码规范的编写与计划安排
参考文献 微信小程序开发代码规范 ,微信小程序开发规范文档-WXML注释规范

一、目录规范

1.1components (组件文件夹)：

  1. 所有组件相关文件统一放在根目录components下， 以组件名称为子文件夹命名
  2. 引用第三方组件以官方名字命名

1.2images (图片文件夹)：

  1. 项目图片文件放置于根目录的images文件夹下
  2. 组件独有的图片放在当前组件images文件夹下
  3. tabbar图标放在/images/tabbar文件夹下

1.3pages (页面文件夹)

​ 1.命名规则:如user,路径为pages/user/user

二、CSS规范

2.1像素单位

  • 通常使用rpx，特殊情况使用px

2.2缩进:

  • 删除不必要的换行，每一个样式类之间空出一行。 上传git前， 格式化代码

2.3布局:

  • ​ 1.使用flex布局，禁止使用float

2.4最后、注意事项:

  • 这里会记录日常开发应规避的--些问题和一些开发建议

  • 扫码页面应选择常规页面，不建议tabbar页面。tabbar页onload事 件在-个生命周期内只调用一次，如连续扫两次不同码，传入不同
    参数时，onload只会调用一次

  • 使用双向绑定时(model:value) ，参数必须是单独的

    • // 正确
model:value="{{myValue}}"
// 错误
model:value="{{myValue.test}}"

三、注释

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

注释代码以结尾。

  • 标准写法

    <!--> 动态列表 -->

  • 错误写法

    <!---> 动态列表 <-->

3.1团队约定

单行注释

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

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

  • 注释位于注释代码上面

  • 单独占一行

  • 示例

    • 推荐写法：

      <!--积--分--信息-->
<view> ... </view>

    • 不推荐写法：

      <!-- 积分信息 --->
<view> ... </view>

<view> ... </view> <!-- 积分信息 -->

<view>  <!-- 积分信息 -->
    ... 
</view>

    代码块注释

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

    • 注释内容前后各一个空格字符
    • 表示代码块开始， 表示代码块结束
    • 代码块与代码块之间相隔一行

    示例

    • 推荐写法：

      <!-- 评论列表 开始 -->
<view class="comment_list"> 
    ...
</view>
<!-- 评论列表 结束 -->

    • 不推荐写法：

    嵌套代码块注释

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

    <!-- 注释内容 开始 -->
<!-- 注释内容 结束 -->

    改为

    <!-- /注释内容 -->

    示例：

    • 推荐写法：

          <view class="personal_info">
        ...
    </view>
    <!-- /个人信息 -->
    
    <view class="personal_event_list">
        ...
    </view>
    <!-- /动态列表 -->
    
</view>
<!-- 个人主页 结束 -->

    • 不推荐写法：

          <!-- 个人信息 开始 -->
    <view class="personal_info">
        ...
    </view>
    <!-- 个人信息 结束 -->
    
    <!-- 动态列表 开始 -->
    <view class="personal_event_list">
        ...
    </view>
    <!-- 动态列表 结束 -->
    
</view>
<!-- 个人主页 结束 -->
 posted on 2022-05-25 23:32  摩天脆脆冰淇淋队  阅读(26)  评论(0)  编辑  收藏  举报