命名规范
- 文件夹用小驼峰式命名法——例:camelCase;
- Vue组件文件用大驼峰式命名法——例:PascalCase;
- 图像文件采用全小写方式,多个单词以下划线分隔——例:pic_people.jpg;
- CSS文件及JavaScript文件采用全小写方式,多个单词以短横线分隔——例:date-util.js;
- 组件名应该倾向于完整单词而非缩写;
- 变量名采用小驼峰式命名法;
- 常量名采用全大写方式,多个单词以下划线分隔;常量名采用全大写方式,多个单词以下划线分隔。
组件导入规范
- 若某页面的 JS 体积较大,可以通过组件懒加载进行资源拆分,利用浏览器并行下载资源,提升下载速度;
- 若某组件需要在一定条件下才触发,则应考虑懒加载的方式导入组件;
- 若某组件复用性较高,则应将该组件抽离,并以懒加载的方式导入该组件。
组件文件内部编程风格
- 建议参考Vue官方推出的风格指南。
函数注释及文件注释
- 如无必要,勿增注释;
- 如有必要,尽量详尽;如有必要,尽量详尽。
图片资源、字体资源及svg文件存放
- 图片资源应统一存放在 ./src/assets/image 文件夹内,并在 image 文件夹下建立模块文件,并将图片放入模块文件内;
- 字体资源应统一存放在 ./src/assets/fonts 文件夹内;
- svg文件应统一存放在 ./src/icons/svg 文件夹内;文件夹内。
页面历史
概览
内容工具