1. 文件命名:
- 项目命名:以小写字母命名,中划线分割。如my-project。
- 目录命名:以小驼峰命名法,除第一个单词之外,其他单词首字母大写。如myDir。
- JS/TS 文件:以小写字母命名,多个单词以下划线连接,例如 util.js、util_helper.js
- 组件文件:遵循 Pascal 命名法(大驼峰),例如 AddressPicker.vue。
- HTML/CSS文件:命名以字母开头而不是数字,且字母一律小写,以中划线连接且不带其他标点符号。如my_page.html、my_page.css。
2. 图片命名:
logo:LOGO类
icon_:模块类固化的图标
btn_:按钮
bg_:可平铺或者大背景
…
3. 路由跳转
getItemById //根据ID获取数据元素
getItemsBySelected //根据传入的已选列表ID来获取列表全部数据
queryUserByUid //根据UID查询用户
formatDate //格式化日期
convertCurrency //转换货币单位
inverseList //反转数据列表
toggleAllSelected //切换所有已选择数据状态
parseXml //解析XML数据
flatSelect //展开选择数据
sortByDesc //按降序排序
4. 构造函数
- 命名方式:大驼峰式命名法,首字母大写
- 命名规范:前缀为名称。
- 公共属性和方法:跟变量和函数的命名一样。
- 私有属性和方法:前缀为_(下划线),后面跟公共属性和方法一样的命名方式。
5. 其他
- 原则上公有接口的命名为首字母大写,私有接口的命名为首字母小写
- 使用单引号定义字符串
- 不要混用tab和space,或在一处使用多个tab或space
- 对上下文this的引用只能使用’_this’, ‘that’, 'self’其中一个来命名
- 行尾不要有空白字符
- switch的falling through和no default的情况一定要有注释特别说明
- 不允许有空的代码块