前端代码书写规范(基础)

一:HTML规范

1.HTML标签名、类名、标签属性和大部分属性值统一用小写,基本所有的HTML代码使用小写。

2.不需要为 CSS、JS 指定类型属性,HTML5 中默认已包含。 例如:<link rel="stylesheet" href="" >

3.元素属性值使用双引号语法,元素属性值可以写上的都写上。  例如:<input type="radio" name="name" checked="checked" >

4.元素嵌套规范,每个块状元素独立一行,内联元素可选。

1 <div>
2     <h1></h1>
3     <p></p>
4 </div>    
5 <p><span></span><span></span></p>

二、图片规范

1.内容图:

内容图多以商品图等照片类图片形式存在,颜色较为丰富,文件体积较大

  • 优先考虑 JPEG 格式,条件允许的话优先考虑 WebP 格式

  • 尽量不使用PNG格式,PNG8 色位太低,PNG24 压缩率低,文件体积大

  • PC平台单张的图片的大小不应大于 200KB。

2.背景图

背景图多为图标等颜色比较简单、文件体积不大、起修饰作用的图片

  • PNG 与 GIF 格式,优先考虑使用 PNG 格式,PNG格式允许更多的颜色并提供更好的压缩率

  • 图像颜色比较简单的,如纯色块线条图标,优先考虑使用 PNG8 格式,避免不使用 JPEG 格式

  • 图像颜色丰富而且图片文件不太大的(40KB 以下)或有半透明效果的优先考虑 PNG24 格式

  • 图像颜色丰富而且文件比较大的(40KB - 200KB)优先考虑 JPEG 格式

  • 条件允许的,优先考虑 WebP 代替 PNG 和 JPEG 格式

三、CSS规范

1.代码大小写

样式选择器,属性名,属性值关键字全部使用小写字母书写,属性字符串允许使用大小写。

2.选择器

  • 尽量少用通用选择器 *

  • 不使用 ID 选择器

  • 不使用无具体语义定义的标签选择器

3.易读性层面

逗号, 冒号: 后面 要加一个空格。

统一使用单引号。

4.书写顺序

  1. 布局定位属性:display / position / float / clear / visibility / overflow(建议 display 第一个写,毕竟关系到模式)

  2. 自身属性:width / height / margin / padding / border / background

  3. 文本属性:color / font / text-decoration / text-align / vertical-align / white- space / break-word

  4. 其他属性(CSS3):content / cursor / border-radius / box-shadow / text-shadow / background:linear-gradient …

四、常用命名推荐

ClassName含义
about 关于
account 账户
arrow 箭头图标
article 文章
aside 边栏
audio 音频
avatar 头像
bg,background 背景
bar 栏(工具类)
branding 品牌化
crumb,breadcrumbs 面包屑
btn,button 按钮
caption 标题,说明
category 分类
chart 图表
clearfix 清除浮动
close 关闭
col,column
comment 评论
community 社区
container 容器
content 内容
copyright 版权
current 当前态,选中态
default 默认
description 描述
details 细节
disabled 不可用
entry 文章,博文
error 错误
even 偶数,常用于多行列表或表格中
fail 失败(提示)
feature 专题
fewer 收起
field 用于表单的输入区域
figure
filter 筛选
first 第一个,常用于列表中
footer 页脚
forum 论坛
gallery 画廊
group 模块,清除浮动
header 页头
help 帮助
hide 隐藏
hightlight 高亮
home 主页
icon 图标
info,information 信息
last 最后一个,常用于列表中
links 链接
login 登录
logout 退出
logo 标志
main 主体
menu 菜单
meta 作者、更新时间等信息栏,一般位于标题之下
module 模块
more 更多(展开)
msg,message 消息
nav,navigation 导航
next 下一页
nub 小块
odd 奇数,常用于多行列表或表格中
off 鼠标离开
on 鼠标移过
output 输出
pagination 分页
pop,popup 弹窗
preview 预览
previous 上一页
primary 主要
progress 进度条
promotion 促销
rcommd,recommendations 推荐
reg,register 注册
save 保存
search 搜索
secondary 次要
section 区块
selected 已选
share 分享
show 显示
sidebar 边栏,侧栏
slide 幻灯片,图片切换
sort 排序
sub 次级的,子级的
submit 提交
subscribe 订阅
subtitle 副标题
success 成功(提示)
summary 摘要
tab 标签页
table 表格
txt,text 文本
thumbnail 缩略图
time 时间
tips 提示
title 标题
video 视频
wrap 容器,包,一般用于最外层
wrapper 容器,包,一般用于最外层

  

 总结:css类名,id名使用 破折号, js 变量使用 驼峰或者下划线,  文件名使用下划线

posted @ 2021-05-20 23:56  zzzzzyyyyyy  阅读(728)  评论(0编辑  收藏  举报