前端开发规范 :
-
代码规范
1.1 写符合eslint规范的代码
1.2 能以背景形式呈现的图片, 尽量写入css样式中; 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;
1.3 代码中一次缩进2个空格
1.4 语义化书写自定义标签或变量(禁止出现 a b 1 2 3这种无实际意义的代码)
1.5 无特殊情况下统一用驼峰书写代码(不要人为缩短命名到最小除了传统的 for 循环中的计数器 i 等简化的情况,变量命名必须长到有明确意义)
1.6 尽可能多的在代码中添加注释,书写一致并且可读的注释,编写可维护性高,易于维护的代码
1.7 html中属性的值使用双引号 js中属性的值使用单引号
1.8 css中减少不必要的嵌套,尽量不超过4层
1.9 尽力编写可通用化的函数,让它接受参数并返回值。这样有利于充分的代码重用,而且一旦与引入及外部脚本配合起来,能在脚本需要修改时减少开销。例如,相比
硬编码一个带有窗口大小、选项和url的弹出式窗口,不如编写一个接受大小、url和选项作为变量的函数。 给代码添加注释!这会有利于减少在调试Javascript函数上花费的时间
。
1.10 最小化全局变量 - 你创建的全局变量越少越好。任何全局变量明确指认:window.xxx =(尽可能的选择 let 或 const 避免内存污染)
1.11 不限和全部的下拉选择统一由前端手动加 传给后端默认为 -1
1.12 时间格式统一传时间戳(毫秒)
2.提交规范
2.1. 提交的代码不能有报错信息
2.2. 提交代码备注信息需要注明提交内容
. feat :新功能
. fix :修复bug
. doc : 文档改变
. style : 代码格式改变
. refactor :某个已有功能重构
.perf :性能优化
.test :增加测试
. build :改变了build工具 如 grunt换成了 npm
.revert: 撤销上一次的 commit
3.文件规范
3.1. 使用驼峰方式命名文件名与文件所在的文件夹,便于统一配置;
3.2. 确保文件命名总是以字母开头而不是数字;
3.3. 特殊含义的文件,需要对文件增加前后缀或特定的扩展名(比如 .min.js, .min.css),抑或一串前缀(比如 all.main.min.css)。使用点分隔符来区分这些在文
件名中带有清晰意义的元数据。
4.项目规范(vue)
4.1 src文件下 assets 统一放置静态资源
4.2 src文件下 components 放置公用组件以内置文件夹名对应模块名 公用的命名统一为public 每个模块内如有组件规则同上
4.3 全局过滤器统一写在 src文件下 filter内
4.4 全局工具类统一写在 src文件下 utils内
4.5 src文件下 router目录结构必须按模块书写
4.5 router文件内 meta标签内必须要有title属性