代码规范
git commit
规范
每次提交 git commit
的时候总是有点难受,不知道怎么写?
还有不同人写的风格完全不一样,
1.安装Commitizen
npm install -g commitizen
2.项目运行命令行
commitizen init cz-conventional-changelog --save --save-exact
凡是用到git commit
命令,一律改为使用git cz
这时,就会出现选项,用来生成符合格式的 Commit message
还有一些其他安装方式,具体参考上面链接的文档即可.
代码规范
Airbnb 代码规范 https://github.com/airbnb/jav…
eslint 代码检查 https://cn.eslint.org
korofileheader 注释生成 https://marketplace.visualstu…
凹凸实验室代码规范 https://guide.aotu.io/index.html
react 代码规范 https://github.com/airbnb/jav…
vue 代码规范 https://cn.vuejs.org/v2/style…
命名规则
Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo
Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo
函数命名规则
动词 | 含义 | 返回值 | |
---|---|---|---|
can | 判断是否可执行某个动作(权限) | 函数返回一个布尔值。true:可执行;false:不可执行 | |
has | 判断是否含有某个值 | 函数返回一个布尔值。true:含有此值;false:不含有此值 | |
is | 判断是否为某个值 | 函数返回一个布尔值。true:为某个值;false:不为某个值 | |
get | 获取某个值 | 函数返回一个非布尔值 | |
set | 设置某个值 | 无返回值、返回是否设置成功或者返回链式对象 | |
load | 加载某些数据 | 无返回值或者返回是否加载完成的结果 |
辅助命名codelf
https://unbug.github.io/codelf/
一个辅助命名的网站, 也有VS Code
插件扩展,取名的时候时间比较实用