命名规范

命名方式

1. 驼峰命名法（camelCase）：要求第一个单词首字母小写，后面其他单词首字母大写。如：myAge、myName、manHeight

   • 普通变量使用

2. 大驼峰命名法、帕斯卡命名法（UpperCamelCase）：与小驼峰式命名法的最大区别在于，每个单词的第一个字母都要大写。如：MyAge、MyName、ManHeight

   • 组件、类变量使用

3. 蛇形命名法（snake_case）：各个单词之间使用_短横线分割。如：my_age、my_name、man_height

4. 串式命名法（kebab-case）：各个单词之间使用-短横线分割。如：my-age、my-name、man-height

   • 文件名称使用
   • html元素使用

通用

• 名称只能由字母、数字、下划线、$符号组成
• 不能以数字开头
• 名称不能使用程序语言的关键字
• 坚决不允许出现中文

正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式可以特殊使用，但尽量避免采用。

ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通用的名称，可视同英文。

在避免冲突并描述清楚的前提下尽可能短：

• nav：✔
• navigation：❌
• comment：✔
• com：❌
• error：✔
• red:❌

项目命名

使用kebab-case，如：dayesmart-tourism-console

1. dayesmart：公司域
2. tourism：项目名称，使用英文，可以衔接多个单词如：guilin-tourism
3. console：项目类型：
   • console：后台管理
   • screen：可视化
   • mini：小程序
   • h5：移动端web
   • web：pc端web

目录命名

使用kebab-case：

• 使用完整单词，尽量不用缩写
• 完整英文单词使用复数表示，缩写单词不用复数

文件命名

使用kebab-case

• 使用完整单词，尽量不用缩写

变量命名

使用camelCase

方法名称必须是【动词】或者【动词+名词】的方式，如：

• getHttpMessage
• openShopCarInfoDialog
• saveShopCarData

函数方法常用的动词：

1. get 获取/set 设置
2. add 增加/remove 删除
3. create 创建/destory 移除
4. start 启动/stop 停止
5. open 打开/close 关闭
6. read 读取/write 写入
7. load 载入/save 保存
8. create 创建/destroy 销毁
9. begin 开始/end 结束
10. backup 备份/restore 恢复
11. import 导入/export 导出
12. split 分割/merge 合并
13. inject 注入/extract 提取
14. attach 附着/detach 脱离
15. bind 绑定/separate 分离
16. view 查看/browse 浏览
17. edit 编辑/modify 修改
18. select 选取/mark 标记
19. copy 复制/paste 粘贴
20. undo 撤销/redo 重做
21. insert 插入/delete 移除
22. add 加入/append 添加
23. clean 清理/clear 清除
24. index 索引/sort 排序
25. find 查找/search 搜索
26. increase 增加/decrease 减少
27. play 播放/pause 暂停
28. launch 启动/run 运行
29. compile 编译/execute 执行
30. debug 调试/trace 跟踪
31. observe 观察/listen 监听
32. build 构建/publish 发布
33. input 输入/output 输出
34. encode 编码/decode 解码
35. encrypt 加密/decrypt 解密
36. compress 压缩/decompress 解压缩
37. pack 打包/unpack 解包
38. parse 解析/emit 生成
39. connect 连接/disconnect 断开
40. send 发送/receive 接收
41. download 下载/upload 上传
42. refresh 刷新/synchronize 同步
43. update 更新/revert 复原
44. lock 锁定/unlock 解锁
45. checkout 签出/checkin 签入
46. submit 提交/commit 交付
47. push 推/pull 拉
48. expand 展开/collapse 折叠
49. begin 起始/end 结束
50. start 开始/finish 完成
51. enter 进入/exit 退出
52. abort 放弃/quit 离开
53. obsolete 废弃/depreciate 废旧
54. collect 收集/aggregate 聚集

增删查改统一使用如下 5 个单词

• add
• delete
• detail
• update
• get

常量命名在snake_case的基础上使用全大写，并使语义表达清楚：

• MAX_STOCK_COUNT：✔
• MAX_COUNT：❌

元素类名、id

使用kebab-case：

必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。