黄金定律
永远遵循同一套编码规范,规范自己的代码风格,同时不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。
使用命名法
- 大驼峰命名法
- 小驼峰命名法
- 下划线命名法
应用场景
项目文件夹
跟业务相关的使用大驼峰命名法,原则上不使用下划线
- VideoProjection
- AudioProgection
- TextProgection
跟业务无关的使用小驼峰命名法 - src
- build
- core
文件命名
使用小驼峰命名法,复合页面使用小写加_加小驼峰
简单页面
- index.html 首页
- main.html/main.js 首页
- download.html 下载页面
- index.css 首页样式
- main.css 主样式
复合页面 - pop_register.html 注册弹框
- pop_ogin.html 登录弹框
- pop_register.css注册弹框样式
- pop_login.css登录弹框样式
变量/函数命名
构造函数名使用大驼峰命名
- Student
- Project
- Work
构造函数内方法名使用_+小驼峰 - _init
- _addName
- _delectAge
普通变量名使用小驼峰命名 - userName
- userAge
- userSex
普通函数名使用小驼峰命名 - getUserName
- getUserAge
- 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 {*}
*/