QShop商城-开发规范

QShop商城-项目介绍

QShop商城，是全新推出的一款轻量级、高性能、前后端分离的电商系统，支持微信小程序，前后端源码100%开源，完美支持二次开发，让您快速搭建个性化独立商城。 技术架构：.Net6/7、WebAPI、Swagger、NUnit、VUE、Element-UI、Ant Design Vue，专注轻量可持续稳定的高可用系统，可学习可商用。

QShop商城-开发规范

  • 后端所有类名,方法,命名空间、类型、枚举类型、枚举值、事件、属性、常量 双峰命名:ListByWhere  所有参数、变量 单峰命名:fileName ),私有属性前缀一致以下划线+单峰命名法 如 :_fileName
  • 前端js 命名可以依照vscode变量规范,变量必须是有意义的单词,除循环变量for(var i=0)外不允许单字母命名(比如:d)
  • 单表列表查询方法名统一使用ListByWhere 分页查询统一使用SearchByWhere,单表内新增为Add 修改为Update 新增或修改AddOrUpdate ,根据ID查询单条记录为GetModel
  • 类名,方法必须以方法头注释方式注释方法用途,及传入参数注释.
  • 所有类不应超过500行 ,方法不应该超过40行最多60行 超过请拆分方法和类(一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小,超过60行肯定有问题)
  • 所有方法传入参数不允许超过5个,如超过5个请新建实体类至ViewModel层,以对象形式传递,实体类内属性必须属性注释(请严格执行,此处会带来一定工作量)
  • 除for循环的循环条件外所有变量以及参数等不允许出现无意义参数名,以及不常用简写
  • 凡符合下表所列的集合类型，应添加相应的前缀,以product为例

    Arrary arrProduct

    List listProduct

    DataTable/HashTable tbProduct

    Dictionary dicProcudct

posted on 2024-05-30 23:25  qiushuangju1  阅读(108)  评论(0)  编辑  收藏  举报

导航