命名规范
为确保项目文件、目录的一致性,请按照以下命名规范进行命名。
文件和文件夹命名
统一用小写加连字符 -
命名,多个单词用连字符连接
sh
views
├── my-home
│ └── index.vue
Vue 组件名称
组件名称统一用烤肉串 Kebab-Case
法命名,单词全小写且用 -
连接
sh
components
├── pro-table.vue
├── pro-form.vue
├── index.vue
引入组件时用 Pascal-Case
命名:
vue
<script setup lang="ts">
import ProTable from "@/components/pro-table.vue";
</script>
<template>
<ProTable />
</template>
构造函数、class 类、TS 类型命名
统一用 Pascal-Case
法命名,多个单词首字母大写
ts
function Person() {}
class Person {}
type Person = {
name: string;
};
interface Person {
name: string;
}
变量、普通函数命名
统一用 Camel-Case
法命名,多个单词首字母小写
ts
let num: number = 1;
function getNum() {}
常量命名
统一用大写字母命名,多个单词用下划线 _
连接
ts
const MAX_COUNT = 10;
样式的命名
统一用小写字母命名,多个单词用中划线 -
连接
css
.demo {
}
.demo-item {
}
可组合式函数命名
统一用 use
开头,且是 Camel-Case
法命名,多个单词首字母小写
ts
const useDemo = () => {};