前端书写习惯总结

简介: 前端书写习惯总结

CSS 书写规范

class类: 小写字母,'-'分割;

图片: 小写字母,‘-’或者‘_’ 分割;

避免选择器嵌套层级过多,少于3级;

不要随意使用id,id应该按需使用,而不能滥用;

使用CSS缩写属性 ,比如padding:0 10px 5px 5px等等,这样精简代码同时又能提高用户的阅读体验;

不缩写单词,除非一看就明白的单词

CSS 字体单位

px像素(Pixel),相对长度单位,像素px是相对于显示器屏幕分辨率而言的。

em是相对长度单位。相对于当前对象内文本的字体尺寸。如当前对行内文本的字体尺寸未被人为设置,则相对于浏览器的默认字体尺寸。

rem也是相对长度单位,但相对的只是HTML根元素。

CSS 注释格式

用来区分页面的注释:如“/************************产品中心*******************************/”

模块的注释,如/*首页导航栏/ */


CSS 书写规范

class类: 小写字母,'-'分割;

图片: 小写字母,‘-’或者‘_’ 分割;

避免选择器嵌套层级过多,少于3级;

不要随意使用id,id应该按需使用,而不能滥用;

使用CSS缩写属性 ,比如padding:0 10px 5px 5px等等,这样精简代码同时又能提高用户的阅读体验;

不缩写单词,除非一看就明白的单词

CSS 字体单位

px像素(Pixel),相对长度单位,像素px是相对于显示器屏幕分辨率而言的。

em是相对长度单位。相对于当前对象内文本的字体尺寸。如当前对行内文本的字体尺寸未被人为设置,则相对于浏览器的默认字体尺寸。

rem也是相对长度单位,但相对的只是HTML根元素。

CSS 注释格式

用来区分页面的注释:如“/************************产品中心*******************************/”

模块的注释,如/*首页导航栏/ */


常用CSS命名规则

id的命名


(1)页面结构


容器: container

页头:header

内容:content/container

页面主体:main

页尾:footer

导航:nav

侧栏:sidebar

栏目:column

页面外围控制整体布局宽度:wrapper

左右中:left right center

(2)导航


导航:nav

主导航:mainnav

子导航:subnav

顶导航:topnav

边导航:sidebar

左导航:leftsidebar

右导航:rightsidebar

菜单:menu

子菜单:submenu

标题: title

摘要: summary

(3)功能


标志:logo

广告:banner

登陆:login

登录条:loginbar

注册:regsiter

搜索:search

功能区:shop

标题:title

加入:joinus

状态:status

按钮:btn

滚动:scroll

标签页:tab

文章列表:list

提示信息:msg

当前的: current

小技巧:tips

图标: icon

注释:note

指南:guide

服务:service

热点:hot

新闻:news

下载:download

投票:vote

合作伙伴:partner

友情链接:link

版权:copyright

Class命名


(1)颜色:使用颜色的名称或者16进制代码


.red { color: red; }

.f60 { color: #f60; }

(2)字体大小,直接使用”font+字体大小”作为名称


.font-12px { font-size: 12px; }

.font-9pt {font-size: 9pt; }

(3)对齐样式,使用对齐目标的英文名称,如


.left { float:left; }

.bottom { float:bottom; }

(4)标题栏样式,使用”类别+功能”的方式命名,如


.bar-news { }

.bar-product { }


JS规范

JS命名规范

JS 变量命名


命名方法:小驼峰式命名


命名规范:前缀应当是名词。(函数的名字前缀为动词,以此区分变量和函数)


JS 函数命名


命名方法:小驼峰式命名法


命名规范:前缀应当为动词


命名建议:可使用常见动词约定


JS 常量命名


命名方法:名称全部大写


命名规范:使用大写字母和下划线来组合命名,下划线用以分割单词


JS 文件命名


使用短线(-)或句点(.)作为分隔符号,推荐使用句点,最好使用小写英文字符,不要使用其他符号和扩展字符,如 jQuery UI 1.9.0 的源文件可命名为"jquery-ui-1.9.0.js"


使用 .js 扩展名,这个扩展名的兼容性最好。其实任何扩展名都可以,只要是 text 类型、编码正确即可


用句点分隔表示名称中的从属关系,范围大的在前,如jQuery 的表单插件 Form既可以命名为jquery.form.js


JS注释格式


使用多行注释,以/*开头,*/结尾


JS 注意事项


书写格式


JS 换行缩进:采用tab(打散为4个空格)

结束行需添加分号`;`


HTML 规范

1. 尽量减少标签层级;

2. 双标签必须闭合,单标签用斜线闭合;

3. HTML第一行统一使用HTML5标准<!DOCTYPE html>;

4.注意代码加注释,增加可读性,如

<!--内容-->
<div class="content">
    <p>content</p>
</div>

5. 代码缩进统一用4 空格;

相关文章
|
4月前
|
前端开发 JavaScript API
前端代码书写规范
前端代码规范提升项目可维护性和团队协作效率。关注项目命名清晰简洁、一致性,组件命名使用驼峰式且具描述性。JS遵循4空格缩进,分号结束语句,CSS按逻辑排序,HTML注重语义化。注释要功能性、文档化且简洁。遵循规范能减少错误,增强团队沟通。
244 3
|
4月前
|
前端开发 JavaScript 算法
比较流行的前端代码书写规范都有哪些
【4月更文挑战第13天】前端代码规范增进代码可读性和团队协作,包括缩进(用2空格)、命名(变量 camelCase,常量 MY_CONSTANT,类 PascalCase)、注释、语句与表达式、错误处理、代码复用。文件命名规范涉及扩展名、目录结构、简洁文件名、入口文件和配置文件命名。遵循这些规范能提高代码一致性,但需按项目需求调整。不断学习新规范以适应前端技术发展。
53 1
|
Web App开发 JavaScript 前端开发
前端通信:ajax设计方案(五)--- 集成promise规范,更优雅的书写代码
  距离上一篇博客书写,又过去了大概几个月了,这段时间暂时离开了这个行业,让大脑休息一下。一个人旅行,一个人休息,正好也去完成一个目标 --- 拥有自己的驾照。当然,也把自己晒的黑漆马虎的。不过这一段时间虽然在技术上没有学太多东西,但是在心态上给了自己一个沉淀的机会,感觉自己变得更加沉稳和成熟,感觉这就是自己需要找到的自己,回归自我。
1441 0
|
前端开发 JavaScript 程序员
前端js的书写规范和高效维护的方案_自我总结使用的方案
  作为程序员,人生最值得幸福的事有几件: 解决困扰了很长时间的问题 升职加薪 找个漂亮又靠谱的对象 深得领导的喜欢 带领团队冲锋陷阵  ...   哈哈,这些都是梦想,暂时想想就好了。这肯定和我说的东西不符合嘛,大家表多想了。
1055 0
|
4天前
|
SpringCloudAlibaba JavaScript 前端开发
谷粒商城笔记+踩坑(2)——分布式组件、前端基础,nacos+feign+gateway+ES6+vue脚手架
分布式组件、nacos注册配置中心、openfegin远程调用、网关gateway、ES6脚本语言规范、vue、elementUI
谷粒商城笔记+踩坑(2)——分布式组件、前端基础,nacos+feign+gateway+ES6+vue脚手架
|
1月前
|
存储 前端开发 JavaScript
前端语言串讲 | 青训营笔记
前端语言串讲 | 青训营笔记
21 0
|
3月前
|
JSON 前端开发 JavaScript
前端Ajax、Axios和Fetch的用法和区别笔记
前端Ajax、Axios和Fetch的用法和区别笔记
66 2
|
3月前
|
前端开发 JavaScript 数据库
如何实现前后端分离-----前端笔记
如何实现前后端分离-----前端笔记
|
3月前
|
前端开发 安全 NoSQL
技术笔记:Security前端页面配置
技术笔记:Security前端页面配置