我所知的一些代码规范,这里做一个粗略提及。如有错误,欢迎各位指正,也欢迎各位补充。
1. css 代码规范 -- BEM
Bem是块(block)、元素(element)、修饰符(modifier)的简写,由Yandex团队提出的一种前端CSS命名方法论。
很多新手在开始写网页时,在命名方面可能都比较随心所欲。但是在一个正式的项目中,会有很多开发人员同时进行开发,如果每个开发人员都用自己的一套命名,这样会造成命名的识别度和一致性成为很大的问题,还会造成命名污染。这时使用BEM命名方法就可以很好的解决这个问题。
当然使用BEM还有很多其他的好处,例如每个块之间都是独立的,因此不会遇到层叠带来的问题。且这些块可以多次重用,可以减少必须维护的css代码量等。
命名规则:
-
块名称为其元素和修饰符定义了命名空间。
-
命名一般使用小写字母。
-
单词之间可以使用
-分隔。 -
__双下划线:用来连接块和块的子元素,例如:父__子{} -
--双中横线:用来表示元素的不同版本或者不同状态,例如:.block--modifier{}
2. git的commit规范
Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。
$ git commit -m "hello world"
上面代码的-m参数,就是用来指定 commit mesage 的。
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
其中,Header 是必需的,Body 和 Footer 可以省略。
这里我只使用了header,所以其他详情请移步这里
Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。
<type>(<scope>): <subject>// 空一行<body>// 空一行<footer>
(1)type
type用于说明 commit 的类别,只允许使用下面7个标识。
- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docs、chore、style、refactor、test)由你决定,要不要放入 Change log,建议是不要。
(2)scope
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
(3)subject
subject是 commit 目的的简短描述,不超过50个字符。
- 以动词开头,使用第一人称现在时,比如
change,而不是changed或changes - 第一个字母小写
- 结尾不加句号(
.)