前端开发规范

文件命名

文件建议使用小写字母，不用大写字母；文件名包含多个单词时，单词之间建议使用半角的连接线（-）分隔。

变量

小驼峰式命名方法

函数

小驼峰式命名方法（构造函数使用大驼峰命名法）

常量

全部大写

注释

单行注释：
-单独一行：//(双斜线)与注释文字之间保留一个空格
-在代码后面添加注释：//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格。
-注释代码：//(双斜线)与代码之间保留一个空格。

// 调用了一个函数；1)单独在一行
setTitle();
var maxCount = 10; // 设置最大量；2)在代码后面注释
// setName(); // 3)注释代码

多行注释：
-若开始(/* 和结束 _/ )都在一行，推荐采用单行注释
-若至少三行注释时，第一行为/_，最后行为_/，其他行以_开始，并且注释文字与*保留一个空格。

/*
 * 代码执行到这里后会调用setTitle()函数
 * setTitle()：设置title的值
 */
setTitle();

组件开发规范

1. 注册组件

注册组件的时候，全部使用 PascalCase 格式。
import UserBook from './user/UserBook'

2. props 命名规范

在声明prop的时候，其命名应该始终使用camelCase，而在模板中应该始终使用kebab-case

<welcome-message greeting-text="hi"></welcome-message>
<script>
 props: {
 greetingText: String;
 }</script>

3. methods 命名规范

驼峰式命名，统一使用动词或者动词+名词形式
尽量使用常用单词开头（set、get、go、can、has、is）
附： 函数方法常用的动词:

get 获取/set 设置,
add 增加/remove 删除
create 创建/destory 移除
start 启动/stop 停止
open 打开/close 关闭,read 读取/write 写入
load 载入/save 保存,
create 创建/destroy 销毁
begin 开始/end 结束,
backup 备份/restore 恢复
import 导入/export 导出,
split 分割/merge 合并
inject 注入/extract 提取,
attach 附着/detach 脱离bind 绑定/separate 分离,
view 查看/browse 浏览
edit 编辑/modify 修改,
select 选取/mark 标记
copy 复制/paste 粘贴,
undo 撤销/redo 重做
insert 插入/delete 移除,
add 加入/append 添加
clean 清理/clear 清除,
index 索引/sort 排序
find 查找/search 搜索,
increase 增加/decrease 减少
play 播放/pause 暂停,
launch 启动/run 运行
compile 编译/execute 执行,
debug 调试/trace 跟踪
observe 观察/listen 监听,
build 构建/publish 发布
input 输入/output 输出,
encode 编码/decode 解码
encrypt 加密/decrypt 解密,
compress 压缩/decompress 解压缩
pack 打包/unpack 解包,
parse 解析/emit 生成
connect 连接/disconnect 断开,
send 发送/receive 接收
download 下载/upload 上传,
refresh 刷新/synchronize 同步
update 更新/revert 复原,
lock 锁定/unlock 解锁
check out 签出/check in 签入,
submit 提交/commit 交付
push 推/pull 拉,
expand 展开/collapse 折叠
begin 起始/end 结束,
start 开始/finish 完成
enter 进入/exit 退出,
abort 放弃/quit 离开
obsolete 废弃/depreciate 废旧,
collect 收集/aggregate 聚集

4. 多个属性的html元素规范

多个特性的元素，占据一行过长时，应该分多行撰写，每个特性一行。(增强更易读)

5. 元素属性的顺序

原生属性放前面，指令放后面