搜索
博主信息
博文 53
粉丝 0
评论 0
访问量 15703
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
CRMEB 前端命名规范:ThinkPHP6+Uni-app 架构下的代码命名标准
い独霸天下う
原创
378人浏览过

一、命名规范

市面上常用的命名规范:

  • camelCase(小驼峰式命名法 —— 首字母小写)
  • PascalCase(大驼峰式命名法 —— 首字母大写)
  • kebab-case(短横线连接式)
  • snake_a(下划线连接式)

1.1 项目文件命名

1.1.1 项目名

全部采用小写方式, 以短横线分隔。 例:my-project-name

1.1.2 目录名

参照项目命名规则,有复数结构时,要采用复数命名法。例:docs、assets、components、directives、mixins、utils、libs、views。

libs:主要存放第三方库或自定义库,这些库提供了项目所需的核心功能或扩展功能。
utils:主要存放项目内部的工具函数,用于提供项目中的通用功能或辅助功能。

  1. my-project-name/
  2. |- docs // 项目的细化文档目录(可选)
  3. |- nginx // 部署在容器上前端项目 nginx 代理文件目录
  4. |- node_modules // 下载的依赖包
  5. |- public // 静态页面目录
  6. |- index.html // 项目入口
  7. |- src // 源码目录
  8. |- api // http 请求目录
  9. |- assets // 静态资源目录,这里的资源会被wabpack构建
  10. |- icon // icon 存放目录
  11. |- img // 图片存放目录
  12. |- js // 公共 js 文件目录
  13. |- scss // 公共样式 scss 存放目录
  14. |- frame.scss // 入口文件
  15. |- global.scss // 公共样式
  16. |- reset.scss // 重置样式
  17. |- components // 组件
  18. |- plugins // 插件
  19. |- router // 路由
  20. |- routes // 详细的路由拆分目录(可选)
  21. |- index.js
  22. |- store // 全局状态管理
  23. |- libs // 第三方库或自定义库
  24. |- utils // 工具存放目录
  25. |- request.js // 公共请求工具
  26. |- views // 页面存放目录
  27. |- App.vue // 根组件
  28. |- main.js // 入口文件
  29. |- tests // 测试用例
  30. |- .browserslistrc// 浏览器兼容配置文件
  31. |- .editorconfig // 编辑器配置文件
  32. |- .eslintignore // eslint 忽略规则
  33. |- .eslintrc.js // eslint 规则
  34. |- .gitignore // git 忽略规则
  35. |- babel.config.js // babel 规则
  36. |- Dockerfile // Docker 部署文件
  37. |- package-lock.json
  38. |- package.json // 依赖
  39. |- README.md // 项目 README
  40. |- vue.config.js // webpack 配置

1.1.3 图像文件名

全部采用小写方式, 优先选择单个单词命名,多个单词命名以下划线分隔。

  1. banner_sina.gif
  2. menu_aboutus.gif
  3. menutitle_news.gif
  4. logo_police.gif
  5. logo_national.gif
  6. pic_people.jpg
  7. pic_TV.jpg

1.1.4 HTML 文件名

全部采用小写方式, 优先选择单个单词命名,多个单词命名以下划线分隔。

  1. error_report.html
  2. success_report.html

1.1.5 CSS 文件名

全部采用小写方式, 优先选择单个单词命名,多个单词命名以短横线分隔。

  1. normalize.less
  2. base.less
  3. date-picker.scss
  4. input-number.scss

1.1.6 JavaScript 文件名

全部采用小写方式, 优先选择单个单词命名,多个单词命名以短横线分隔。

  1. index.js
  2. plugin.js
  3. util.js
  4. date-util.js
  5. account-model.js
  6. collapse-transition.js

上述规则可以快速记忆为“静态文件下划线,编译文件短横线”。

1.2 Vue 组件命名

1.2.1 单文件组件名

文件扩展名为 .vuesingle-file components (单文件组件)。单文件组件名应该始终是单词大写开头 (PascalCase)。

  1. components/
  2. MyComponent.vue

1.2.2 单例组件名

只拥有单个活跃实例的组件应该以 **The** 前缀命名,以示其唯一性。

这不意味着组件只可用于一个单页面,而是每个页面只使用一次。这些组件永远不接受任何 prop,因为它们是为你的应用定制的。如果你发现有必要添加 prop,那就表明这实际上是一个可复用的组件,只是目前在每个页面里只使用一次。

比如,头部和侧边栏组件几乎在每个页面都会使用,不接受 prop,该组件是专门为该应用所定制的。

  1. components/
  2. TheHeading.vue
  3. TheSidebar.vue

1.2.3 基础组件名

基础组件:不包含业务,独立、具体功能的基础组件,比如日期选择器模态框等。这类组件作为项目的基础控件,会被大量使用,因此组件的 API 进行过高强度的抽象,可以通过不同配置实现不同的功能。

应用特定样式和约定的基础组件(也就是展示类的、无逻辑的或无状态、不掺杂业务逻辑的组件) 应该全部以一个特定的前缀开头 —— Base。基础组件在一个页面内可使用多次,在不同页面内也可复用,是高可复用组件。

  1. components/
  2. BaseButton.vue
  3. BaseTable.vue
  4. BaseIcon.vue

1.2.4 业务组件

业务组件:它不像基础组件只包含某个功能,而是在业务中被多个页面复用的(具有可复用性),它与基础组件的区别是,业务组件只在当前项目中会用到,不具有通用性,而且会包含一些业务,比如数据请求;而基础组件不含业务,在任何项目中都可以使用,功能单一,比如一个具有数据校验功能的输入框。

掺杂了复杂业务的组件(拥有自身 **data** **prop** 的相关处理)即业务组件应该以 Custom 前缀命名。业务组件在一个页面内比如:某个页面内有一个卡片列表,而样式和逻辑跟业务紧密相关的卡片就是业务组件。

  1. components/
  2. CustomCard.vue

1.2.5 紧密耦合的组件名

和父组件紧密耦合的子组件应该以父组件名作为前缀命名。 因为编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。

  1. components/
  2. TodoList.vue
  3. TodoListItem.vue
  4. TodoListItemButton.vue

1.2.6 组件名中单词顺序

组件名应该以高级别的 (通常是一般化描述的) 单词开头,以描述性的修饰词结尾。 因为编辑器通常会按字母顺序组织文件,所以现在组件之间的重要关系一目了然。如下组件主要是用于搜索和设置功能。

  1. components/
  2. SearchButtonClear.vue
  3. SearchButtonRun.vue
  4. SearchInputQuery.vue
  5. SearchInputExcludeGlob.vue
  6. SettingsCheckboxTerms.vue
  7. SettingsCheckboxLaunchOnStartup.vue

还有另一种多级目录的方式,把所有的搜索组件放到“search”目录,把所有的设置组件放到“settings”目录。我们只推荐在非常大型 (如有 100+ 个组件) 的应用下才考虑这么做,因为在多级目录间找来找去,要比在单个 components 目录下滚动查找要花费更多的精力。

1.2.7 完整单词的组件名

组件名应该倾向于完整而不是缩写。 编辑器中的自动补全已经让书写长命名的代价非常之低了,而其带来的明确性却是非常宝贵的。不常用的缩写尤其应该避免。

  1. components/
  2. StudentDashboardSettings.vue
  3. UserProfileOptions.vue

1.3 代码参数命名

1.3.1 name

组件名应该始终是多个单词,应该始终是 PascalCase 的。 根组件 App 以及 <transition><component>之类的 Vue 内置组件除外。这样做可以避免跟现有的以及未来的 HTML 元素相冲突,因为所有的 HTML 元素名称都是单个单词的。

  1. export default {
  2. name: 'ToDoList',
  3. // ...
  4. }

1.3.2 prop

在声明 prop 的时候,其命名应该始终使用 camelCase(驼峰) 。我们单纯的遵循每个语言的约定,在 JavaScript 中更自然的是 camelCase。而在 HTML 中则是 kebab-case。

  1. <WelcomeMessage greeting-text="hi"/>
  1. export default {
  2. name: 'MyComponent',
  3. // ...
  4. props: {
  5. greetingText: {
  6. type: String,
  7. required: true,
  8. validator: function (value) {
  9. return ['syncing', 'synced',].indexOf(value) !== -1
  10. }
  11. }
  12. }
  13. }

1.3.3 router

Vue Router Path 命名采用 kebab-case 格式。 用 Snake(如:/user_info)或 camelCase(如:/userInfo)的单词会被当成一个单词,搜索引擎无法区分语义。

  1. // bad
  2. {
  3. path: '/user_info', // user_info 当成一个单词
  4. name: 'UserInfo',
  5. component: UserInfo,
  6. meta: {
  7. title: ' - 用户',
  8. desc: ''
  9. }
  10. },
  11. // good
  12. {
  13. path: '/user-info', // 能解析成 user info
  14. name: 'UserInfo',
  15. component: UserInfo,
  16. meta: {
  17. title: ' - 用户',
  18. desc: ''
  19. }
  20. },

1.3.4 模板中组件

对于绝大多数项目来说,在单文件组件和字符串模板中组件名应该总是 PascalCase 的,但是在 DOM 模板中总是 kebab-case 的。

  1. <!-- 在单文件组件和字符串模板中 -->
  2. <MyComponent/>
  3. <!-- 在 DOM 模板中 -->
  4. <my-component></my-component>

1.3.5 自闭合组件

在单文件组件、字符串模板和 JSX 中没有内容的组件应该是自闭合的——但在 DOM 模板里永远不要这样做。

  1. <!-- 在单文件组件和字符串模板中 -->
  2. <MyComponent/>
  3. <!-- 在所有地方 -->
  4. <my-component></my-component>

1.3.6 变量

  • 命名方法:camelCase
  • 命名规范:类型 + 对象描述或属性的方式
  1. // bad
  2. var getTitle = "LoginTable"
  3. // good
  4. let tableTitle = "LoginTable"
  5. let mySchool = "我的学校"

1.3.7 常量

  • 命名方法:全部大写下划线分割
  • 命名规范:使用大写字母和下划线来组合命名,下划线用以分割单词
  1. const MAX_COUNT = 10
  2. const URL = 'http://test.host.com'

1.3.8 方法

  • 命名方法:camelCase
  • 命名规范:统一使用动词或者动词 + 名词形式
  1. // 1、普通情况下,使用动词 + 名词形式
  2. // bad
  3. gonextPageshowopenlogin
  4. // good
  5. jumpPageopenCarInfoDialog
  6. // 2、请求数据方法,以 data 结尾
  7. // bad
  8. takeDataconfirmDatagetListpostForm
  9. // good
  10. getListDatapostFormData
  11. // 3、单个动词的情况
  12. initrefresh
动词 含义 返回值
can 判断是否可执行某个动作 (权 ) 函数返回一个布尔值。true:可执行;false:不可执行;
has 判断是否含有某个值 函数返回一个布尔值。true:含有此值;false:不含有此值;
is 判断是否为某个值 函数返回一个布尔值。true:为某个值;false:不为某个值;
get 获取某个值 函数返回一个非布尔值
set 设置某个值 无返回值、返回是否设置成功或者返回链式对象

1.3.9 自定义事件

自定义事件应始终使用 kebab-case 的事件名。

不同于组件和 prop,事件名不存在任何自动化的大小写转换。而是触发的事件名需要完全匹配监听这个事件所用的名称。

  1. this.$emit('my-event')
  1. <MyComponent @my-event="handleDoSomething" />

不同于组件和 prop,事件名不会被用作一个 JavaScript 变量名或 property 名,所以就没有理由使用 camelCase 或 PascalCase 了。并且 v-on 事件监听器在 DOM 模板中会被自动转换为全小写 (因为 HTML 是大小写不敏感的),所以 v-on:myEvent 将会变成 v-on:myevent——导致 myEvent 不可能被监听到。

由原生事件可以发现其使用方式如下:

  1. <div
  2. @blur="toggleHeaderFocus"
  3. @focus="toggleHeaderFocus"
  4. @click="toggleMenu"
  5. @keydown.esc="handleKeydown"
  6. @keydown.enter="handleKeydown"
  7. @keydown.up.prevent="handleKeydown"
  8. @keydown.down.prevent="handleKeydown"
  9. @keydown.tab="handleKeydown"
  10. @keydown.delete="handleKeydown"
  11. @mouseenter="hasMouseHoverHead = true"
  12. @mouseleave="hasMouseHoverHead = false">
  13. </div>

而为了区分原生事件自定义事件在 Vue 中的使用,建议除了多单词事件名使用 kebab-case 的情况下,命名还需遵守为 **on** + 动词 的形式,如下:

  1. <!-- 父组件 -->
  2. <div
  3. @on-search="handleSearch"
  4. @on-clear="handleClear"
  5. @on-clickoutside="handleClickOutside">
  6. </div>
  1. // 子组件
  2. export default {
  3. methods: {
  4. handleTriggerItem () {
  5. this.$emit('on-clear')
  6. }
  7. }
  8. }

1.3.10 事件方法

  • 命名方法:camelCase
  • 命名规范:handle + 名称(可选)+ 动词
  1. <template>
  2. <div
  3. @click.native.stop="handleItemClick()"
  4. @mouseenter.native.stop="handleItemHover()">
  5. </div>
  6. </template>
  7. <script>
  8. export default {
  9. methods: {
  10. handleItemClick () {
  11. //...
  12. },
  13. handleItemHover () {
  14. //...
  15. }
  16. }
  17. }
  18. </script>

附件:https://gitee.com/ZhongBangKeJi/CRMEB

本博文版权归博主所有,转载请注明地址!如有侵权、违法,请联系admin@php.cn举报处理!
全部评论 文明上网理性发言,请遵守新闻评论服务协议
0条评论
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号

  • 登录PHP中文网,和优秀的人一起学习!
    全站2000+教程免费学