个人前端代码规范

黄金定律

永远遵循同一套编码规范,规范自己的代码风格,同时不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。

使用命名法

  1. 大驼峰命名法
  2. 小驼峰命名法
  3. 下划线命名法

应用场景

项目文件夹

跟业务相关的使用大驼峰命名法,原则上不使用下划线

  1. VideoProjection
  2. AudioProgection
  3. TextProgection
    跟业务无关的使用小驼峰命名法
  4. src
  5. build
  6. core

文件命名

使用小驼峰命名法,复合页面使用小写加_加小驼峰
简单页面

  1. index.html 首页
  2. main.html/main.js 首页
  3. download.html 下载页面
  4. index.css 首页样式
  5. main.css 主样式
    复合页面
  6. pop_register.html 注册弹框
  7. pop_ogin.html 登录弹框
  8. pop_register.css注册弹框样式
  9. pop_login.css登录弹框样式

变量/函数命名

构造函数名使用大驼峰命名

  1. Student
  2. Project
  3. Work
    构造函数内方法名使用_+小驼峰
  4. _init
  5. _addName
  6. _delectAge
    普通变量名使用小驼峰命名
  7. userName
  8. userAge
  9. userSex
    普通函数名使用小驼峰命名
  10. getUserName
  11. getUserAge
  12. getUserSex

注释规范

使用Vscode中koroFileHeader插件中的规范

文件头注释

/*
 * @Author: 林三
 * @Date: 2021-07-19 23:51:23
 * @LastEditors: 林三
 * @LastEditTime: 2021-08-03 01:51:14
 * @Description:vue源码真实入口
 * @FilePath: \vue\src\core\instance\index.js
 */

函数注释

/**
 * @name: 构造函数
 * @param {Object} options 配置参数
 * @return {*}
 */
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值