vue 、js 命名规范

命名规范不是绝对,建议:怎么方便怎么来

一、常见的命名方式

小驼峰                       示例:nodeModules              
大驼峰                       示例:NodeModules
            
短横线分割                   示例:node-modules              
下划线分割                   示例:node_modules   

下划线分割+复数命名           示例:node_modules 
下划线分割+大写命名           示例:CURRENT_TIME 

二、vue 项目命名规范

1. 目录结构命名规范

  1. 项目目录命名规范
短横线分割                   示例:vue2-test-demo
  1. 内部目录命名规范
下划线分割+复数命名          示例:views、node_modules
  1. vue 常见目录结构
// 参考资料:https://www.kancloud.cn/henrycao/ctos3/1782562
├── dist                  # 运行npm build,编译后生成的代码存放目录
├── node_modules          # npm本地依赖包
├── public                # 该目录下的静态资源会被复制到输出目录(dist)中,不经过 webpack处理
├── src
│   ├── api               # 与后端交互使用相关方法,接口定义
│   ├── assets            # 放置一些静态资源,例如图片,图标,字体等
│   ├── components        # 公共组件  
│   ├── lang              # 国际化多语言定义 
│   ├── router            # vue-router相关配置 https://router.vuejs.org/zh/guide/
│   ├── store             # vuex 相关配置 https://vuex.vuejs.org/zh/
│   ├── styles            # 公共样式定义
│   ├── theme             # 主题定义
│   ├── utils             # 工具类定义,详细请阅读“工具类”部分介绍
│   ├── views             # 所有的路由组件,业务功能开发
│   ├── App.vue           # 路由组件的顶层路由
│   └── main.js           # vue入口文件
├── tests                 # 测试
├── .browserslistrc       # 指定项目的目标浏览器的范围,查看“配置项-目标浏览器”了解
├── .env                  # 环境变量配置,详细请阅读“环境变量和模式”部分介绍
├── .gitignore            # 配置不提交到git仓库的文件
├── postcss.config.js     # 配置rem转换,查看“配置项 - postcss.config.js”了解https://www.npmjs.com/package/postcss-px2rem
└── vue.config.js         # 配置文件,详细请阅读“配置项-vue.config.js”部分

2. 文件命名规范

  1. vue 文件
一个单词名使用小写命名,多个单词名使用大驼峰命名
  1. js、ts、html、css、less、scss、图像类、文件
小驼峰                

3. 方法、变量、常量命名规范

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

推荐阅读更多精彩内容