Skip to content

rivercome/Voluteer_admin

Repository files navigation

脚手架代码风格及开发规范

代码风格

具体参照ESlint,主要包括:

  1. 不使用分号
  2. 一律使用单引号
  3. 注释符号与注释间留有一个空格
  4. 使用2格缩进
  5. 函数声明以及各类运算符的使用等需要留有空格
  6. 每一个代码文件结尾需要留空白行

开发规范

该脚手架使用的redux封装库为dva,具体使用参考github

别名(alias)

src目录下所有子目录都对应一个别名(alias) - 且为该目录名。
src目录下新建的目录会自动在webpack中注册一个别名,无需手动操作

dva(model)

规定所有的model文件都在models中编写,可以新建子目录,脚手架会自动将这些文件注册到dva中

routerForm (路由表)

react-router存在的问题 当项目变得庞大时,react-router4的路由书写方式可能会使开发者无从找起。
link或者路由跳转语句完全耦合在代码中时,想要修改一个路由可能是一个令开发者崩溃的事情

脚手架解决方式
通过借鉴vue-router的书写方式,并且针对react的开发习惯进行优化,所以该脚手架将使用路由表的形式进行开发

路由表使用规范

  1. 所有路由表均写在routerForm中,可以键子目录,脚手架将自动获取该目录下的路由表文件
  2. 每个路由表文件均暴露一个数组,数组中每项即为路由对象,包括路由名(name)和路径名(path),可以使用children字段添加子路由,在子路由中可以简写路由也可以写完整路由,具体使用方式参考脚手架示例代码或vue-router的子路由
  3. 通过引入routerForm/index.js可以得到path和所有的name,具体书写方式参考脚手架示例文件
  4. namepath字段必填,且name值不允许重复,否则会抛出错误
  5. 可以通过传入对象向路由中添加queryparams
  6. 可以通过utils目录中的routerPush简单的进行js路由跳转

其他开发规范

  1. 谨慎引第三方包,避免模块不规范导致打包失败。建议引包后进行打包测试引入的包是否规范

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •