文件命名规范
- 文件夹命名
所有文件夹命名一律以小写字母命名,而如果是复数单词为命名的,则以 -
符号为区分。
- 所有静态文件,包括但不限于html、css、js、ts、图片
一律以小写字母命名,而如果是复数单词为命名的,则以 -
符号为区分。
- vue文件
一律用KebabCase(大驼峰命名)格式,MyComponent.vue
的形式。
- 文件格式(应有具体意义)
例如:ts中 user文件夹里面的文件,可以取名为 user-options.ts
等。
例如:组件中 user文件夹里面的文件,可以取名为 UserLogin.vue
等。
方法命名规范
- interface
以大写 I
为开头+大驼峰命名法,例如 IUserOption
。
- enums
以大写 E
为开头+大驼峰命名法,例如 EUserMode
。
- namespace
以大写N
为开头+大驼峰命名法,例如 NUserOption
- hook
以小写 use
为开头,例如 useUserLogin
。
- 组件 name
跟随组件名字即可。
- 通用常数
const MAX_NUM=1
- 通用方法以及参数
一律用小驼峰命名法, userLoginHandler
- 组件名字
跟随组件名字
- 事件名
跟随方法命名法,即小驼峰命名法, @userLoginHandler
路径命名
一律以小写字母命名,而如果是复数单词为命名的,则以 -
符号为区分。