Ant Design Pro基本开发规范

  • 持续更新,大家有好的建议也可以提出来
  • 20210508 1-14点
1、文件/文件夹命名规范
1、components、views下文件夹/文件命名
2、文件夹命名使用大写字母开头PascalBase风格
3、必须包含index.vue
4、其他文件名以大写开头PascalBase风格

components/Breadcrumb/index.vue
components/Hamburage/ItemDetail.vue
viwes/Home/index.vue
viwes/Article/index.vue
viwes/Article/ArticleDetail.vue
2、*.js文件命名规范
1、属于类的.js文件,除了index.js,其他使用PascalBase风格
2、属于其他类型的.js文件,使用kebab-case风格
3、属于Api的, 统一加上Api后辍

index.js
ParentChidren.js
HomeApi.js
3、*.vue文件命名规范
除index.vue外,其他vue文件统一使用PascalBase风格
eg:
index.vue
ArticleDetail.vue
4、*.less/.scss文件命名规范
统一使用kebab-case命名风格
eg:
article-detail.less / article-detail.scss
5、*.css类名命名规范
统一使用 kebab-case命名风格
eg: .article-container
6、方法命名(采用动词+名词),驼峰式划分语义
eg: doSomething(){}
7、变量命名,驼峰式命名
eg: let myName = 'ken'
8、api信息存放位置
src/api/xxx/xxx
src/api/Admin/UserApi.js 跟菜单一一对应,方便查找
9、公共图片、样式文件存放位置
src/assets
10、自定义图标加载
src/core/icons.js
11、通用全局控件加载
src/core/lazy_use.js
12、通用工具类方法
src/utils/Validation/InputValidation.js 工具类/验证/输入验证
方法必须写清楚注释,最好搭配.md文件说明
13、全局用户业务缓存代码存放位置
src/store/modules/

参考写法跟着写即可,比如字典表缓存,固定常用缓存
src/store/modules/user.js

公共的方法也可以放进来,比如地区选择,很多页面用到,没有必要每个页面都写一个完整的actions方法
14、vue文件书写顺序
- vue 标签内容
- script 
--  import 引入组件、库
-- export default 实例化
--- name 为组件选项时起作用
--- components  组件使用
--- props  标签化赋值
--- data 初始化数据,方便渲染
--- created 在模板渲染成html前调用,即通常初始化某些属性值,然后再渲染成视图。
--- mounted 在模板渲染成html后调用,通常是初始化页面完成后,再对html的dom节点进行一些需要的操作。
--- methods 定义方法
--- computed 用来监控自己定义的变量,该变量不在data里面声明
--- watch 只能监控整个对象或单个变量
--- destroyed 实例销毁后调用。
- style

https://cn.vuejs.org/v2/api/#beforeCreate
https://www.cnblogs.com/gunelark/p/8492468.html
不管用不用都要声明出来,固定顺序
image.png
<template>
  <div>
    ${COMPONENT_NAME} page
  </div>
</template>

<script>
export default {
  name: '',
  components: {},
  data () {},
  created: {},
  methods: {},
  mounted: {},
  computed: {},
  watch: {},
  destroyed: {}
}
</script>

<style lang="less" scoped>

</style>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容