# 整体规范
命名不可使用中文拼音
字母统一小写,专有名词可大写
共性在前,个性在后
语义要清楚完整,不要过分简写
# 项目命名
字母组成,中划线拼接
例:my-project-name
webapp-asclepius
# 目录(文件夹)命名
字母组成,下划线拼接
有复数结构时,要采用复数命名法
例:images/
components/
utils/
node_modules/
# 文件命名
文件包括.js
.css
.html
.vue
.sass
.less
图片等文件
字母组成,下划线拼接
例:sass_index.scss
dialog_user_info.vue
# 组件命名
声明&使用:首字母大写,驼峰拼接
// 声明
import DialogUserInfo form '@/components/dialog_user_info'
components: {
DialogUserInfo
}
// 使用
<DialogUserInfo></DialogUserInfo>
# css命名
字母组成,中划线拼接
id采用驼峰式命名
例:.color-white
#theDialog
# js命名
# 变量&函数
常量:大写字母、数字组成,下划线拼接,例:
CONSULT_TYPE
私有变量:字母、数字组成,驼峰拼接,下划线开头,例:_self
普通变量:字母、数字组成,驼峰拼接,例:idCard
构造函数:字母组成,驼峰拼接,首字母大写,例:Vue()
普通函数:字母组成,驼峰拼接,动词+名词方式组合,例:getList()
# 形参
形参本身是可以任意定义的,统一是为了更方便地复用/合并代码
参数 | 含义 | 用法示例 |
---|---|---|
i | 索引 | switchTab(i) {} |
e | 事件 | focusHandler(e) {} |
v | 基本类型值 | setData(v) {} |
obj | 对象 | let arr = mainList.filter(obj => obj.isCheck) |
arr | 数组 | let arr = Array.from(obj) |
fun | 函数 | callback(fun) {} |
item | 列表项 | jumpDetail(item) {} |
element | forEach的项 | forEach(element=>{}) |
key,value | 键值对 | for (let [key, value] of arr) {} |
注释规范 →