html 组件写法,WEB前端之HTML&组件 规范

1.HTML语义化

语义化HTML代码

2.标签

html 标签分为以下几类：

所有具有开始标签和结束标签的元素都必须要写上起止标签，某些允许省略开始标签或和束标签的元素亦都要写上

自闭合标签不要加上结束标签

自定义标签的名字必须包含一个破折号(-)，和都是正确的名字，而和是不正确的。这样的限制使得 HTML 解析器可以分辨那些是标准元素，哪些是自定义元素

自定义标签必须写上开始标签和闭合标签

尽量减少标签数量

3.代码嵌套

块元素可以包含内联元素或某些块元素，但内联元素却不能包含块元素，它只能包含其它的内联元素

标题和段落中不能包含块，如：h1、h2、h3、h4、h5、h6、p、dt

块与内联不能并列，块级元素与块级元素并列、内嵌元素与内嵌元素并列

有些标签是固定的嵌套规则，比如 ul 包含 li、ol 包含 li、dl 包含 dt 和 dd 等等。

4.缩进

统一两个空格缩进

5.元素属性

推荐

不推荐

6.灵活使用伪类

7.注释规范(使用koroFileHeader插件)

单行注释

一般用于简单的描述，如某些状态描述、属性描述等

注释内容前后各一个空格字符，注释位于要注释代码的上面，单独占一行

...

模块注释

注释内容前后各一个空格字符

表示模块开始

表示模块结束，模块与模块之间相隔一行

模块注释内部嵌套模块注释，

单文件组件

1.命名规范

文件命名规范(my-file)

单文件组件命名(my-component)

公用组件命名(pk-component)

模版中组件的命名规范

2.单文件的书写顺序

顶级元素顺序

...

组件配置项顺序

VUE组件开发规范.png

3.组件规范

事件名命名 子组件向父组件抛出的事件名命名：统一 “on-事件名称”，eg：on-click-right

代码文件 开发过程中单个文件不允许超过600行，特别复杂的功能，文件不允许超过1000行

公共组件 需要写上组件的描述，props的参数的描述(使用koroFileHeader插件)

/**

* @description 销售区域组件 v0.1

* @author lentoo

* @date 2019/2/27

* 使用方法：

* 引入组件，v-model 双向绑定

* 返回 选中的 省 市 区 id值

*/

props: {

/**

* @description 起始值，即动画开始前显示的数值

*/

start: {

type: Number,

default: 0

},

/**

* @description 结束值，即动画结束后显示的数值

*/

end: {

type: Number,

required: true

},

/**

* @description 小数位

*/

decimals: {

type: Number,

default: 0

},

}