vue项目文件命名规范推荐

项目命名

mall-management-system // good
mall_management-system // bad
mallManagementSystem // bad

文件夹文件

超过一个单词的统一使用小写字母开头的(kebab-case)命名规范，如show-content、commodity

Vue 文件命名

除了 index.vue文件，件统一使用大驼峰的形式命名 (PascalCase)，如SideMenu.vue、SideMenu.vue、Button.vue、
Input.vue

Js|Css|图片 文件

使用短横线连接的形式命名，比如init-dialog.js、index.js、element-button.scss、logo-bg.png，图片文件禁止使用中文命名。

路由命名规范

路由命名采用全小写，单词用-隔开格式 因为如果你使用下划线或者驼峰形式，会被当成一个单词，搜索引擎无法区分语义,而 - 隔开会显得更加直观和漂亮

vue组件文件顶部注释

/**
* @func
* @todo （该函数描述）
* @param {string/类型定义} a - 参数a的描述
* @param {object/类型定义} b - 参数b的描述
* @param {object[]/类型定义} c - 参数c的描述（可选）
* @returns {Object} 返回值描述
**/

CSS样式注释

/* header */
.header{…}
/*end header */

变量

1.公开变量 使用 Camel 命名法。let showBox= { };
2.私有属性、变量和方法 以下划线 _ 开头 。let _privateMethod = { };
3.私有属性、变量和方法 以下划线 _ 开头 。let _privateMethod = { };
4.常量 使用全部字母大写，单词间下划线分隔的命名方式。const HTML_ENTITY = { };

⚡️ 函数

使用 Camel 命名法。函数的参数, 使用 Camel 命名法。
多使用使用动宾短语。canShow、getStyle、setStyle、
function toString(source) { }
function getData(theBells) { }