web前端规范-CSS的命名

合集下载

软件开发Web前端开发规范

软件开发Web前端开发规范

软件开发Web前端开发规范软件开发Web前端开发规范是指在进行Web前端开发过程中,为了统一团队的代码风格,提高代码的可读性、可维护性和可扩展性而制定的规范。

本文将从代码结构、命名规范、注释规范、HTML规范、CSS规范、JavaScript规范以及版本控制等几个方面,详细阐述Web前端开发规范的内容。

一、代码结构规范:1. 项目根目录下应包含必要的文件,如index.html、package.json 等;2. 将不同类型的文件(如HTML、CSS、JavaScript)分别放在不同的文件夹中,方便管理;3.对于大型项目,可以按照模块对文件进行进一步的组织。

二、命名规范:1. 变量、函数名使用驼峰命名法,如helloWorld;2. 类名使用帕斯卡命名法,如HelloWorld;3.常量名使用全大写字母,如PI;4. 文件名使用小写字母,多个单词使用下划线连接,如index.html。

三、注释规范:1.对于重要的函数、类、模块等,应添加详细的注释说明;2.使用单行注释(//)或多行注释(/**/)来注释代码,注释应描述清楚代码的功能和作用;3.注释应写在代码的上方或右侧,避免在代码行尾添加注释。

四、HTML规范:2.缩进使用两个空格,不使用制表符;4. 使用双引号包裹属性值,如class="container";5.避免使用行内样式,将样式写入CSS文件中。

五、CSS规范:1.代码缩进使用两个空格,不使用制表符;2. 使用中划线连接多个单词,如table-layout;3.选择器命名简洁明了,避免使用过长、复杂的名称;4.属性书写顺序应统一,比如先写布局相关的属性,再写样式相关的属性;5.使用CSS预处理器,如LESS、SASS等,提高开发效率。

六、JavaScript规范:1.使用ES6语法,提高代码的可读性和可维护性;2. 变量声明使用let或const,避免使用var;3.函数命名简洁明了,避免使用过长、复杂的名称;4.将多次使用的代码封装成函数,提高代码的复用性;5.避免使用全局变量和全局函数,减少命名冲突的可能性。

css命名及书写规范

css命名及书写规范

css命名及书写规范CSS命名规范一.文件命名规范全局样式:global.css;框架布局:layout.css;字体样式:font.css;链接样式:link.css;打印样式:print.css;二.常用类/ID命名规范页眉:header内容:content容器:container页脚:footer版权:copyright导航:menu主导航:mainMenu子导航:subMenu标志:logo标语:banner标题:title侧边栏:sidebar图标:Icon注释:note搜索:search按钮:btn登录:login链接:link信息框:manage……常用类的命名应尽量以常见英文单词为准,做到通俗易懂,并在适当的地方加以注释。

对于二级类/ID命名,则采用组合书写的模式,后一个单词的首字母应大写:诸如―搜索框‖则应命名为―searchInput‖、―搜索图标‖命名这―searchIcon‖、―搜索按钮‖命名为―searchBtn‖……CSS书写规范及方法一. 常规书写规范及方法1. 选择DOCTYPE:XHTML 1.0 提供了三种DTD声明可供选择:过渡的(Transitional):要求非常宽松的DTD,它允许你继续使用HTML4.01的标识(但是要符合xhtml的写法)。

完整代码如下:<!DOCTYPE html PUBLIC ―-//W3C//DTD XHTML 1.0 Transitional//EN‖―/TR/xhtml1/DTD/xhtml1-transitional.dtd―>严格的(Strict):要求严格的DTD,你不能使用任何表现层的标识和属性,例如<br>。

完整代码如下:<!DOCTYPE html PUBLIC ―-//W3C//DTD XHTML 1.0 Strict//EN‖―/TR/xhtml1/DTD/xhtml1-strict.dtd―>框架的(Frameset):专门针对框架页面设计使用的DTD,如果你的页面中包含有框架,需要采用这种DTD。

WEB前端开发规范方案文档

WEB前端开发规范方案文档

WEB前端开发规范方案文档一、概述本文档旨在规范前端开发团队的开发流程和编码规范,以提高代码的可读性、可维护性和可扩展性。

本规范适用于Web前端开发工作,包括HTML,CSS和JavaScript等相关技术。

二、项目目录规范1.项目根目录下应包含以下文件或文件夹:- index.html:项目的入口文件;- css文件夹:存放项目的css文件;- js文件夹:存放项目的JavaScript文件;- images文件夹:存放项目的图片文件;- fonts文件夹:存放项目的字体文件;- libs文件夹:存放项目的第三方库文件;- README.md:项目的说明文档。

2.CSS文件命名规范- 使用小写字母和中划线来命名文件,如:main.css;- 使用语义化的名称来命名文件,如:reset.css;- 对于一些通用的样式文件,可以使用常见的名称,如:normalize.css。

3. JavaScript文件命名规范- 使用驼峰命名法来命名文件,如:app.js;- 使用语义化的名称来命名文件,如:utils.js;- 对于一些通用的JavaScript文件,可以使用常见的名称,如:jquery.js。

三、HTML规范2.缩进和换行- 使用两个空格的缩进来表示嵌套关系,不使用tab键;3.属性顺序- 属性应按照以下顺序书写:class、id、data-*、style、src、href、alt、title等。

四、CSS规范1.样式命名规范- 使用小写字母和中划线来命名样式,如:header-title;- 使用语义化的名称来命名样式,如:main-container;-避免使用缩写,提高代码的可读性和可维护性。

2.CSS选择器规范- 使用类选择器来选中元素,不使用id选择器,以免造成样式的耦合性和难以维护性;-避免使用通配符选择器;-避免使用嵌套选择器,以免造成样式的复杂性和性能问题。

3.代码注释规范-使用注释来说明代码的用途和作用;-使用块注释来注释一整段代码,使用行注释来注释一行代码。

前端命名规范

前端命名规范

前端命名规范前端命名规范是一种约定俗成的规则,旨在保证代码的可读性和维护性,使团队成员能够更加高效地协作开发。

下面是一些常见的前端命名规范:1. 文件和文件夹命名规范- 文件名应该使用小写字母,多个单词之间使用连字符“-”分隔,例如:index.html, main.css。

- 文件夹名也应该使用小写字母,多个单词之间使用连字符“-”分隔,例如:images, scripts。

2. HTML/CSS命名规范- HTML和CSS中的类名和ID名应该使用小写字母,多个单词之间使用连字符“-”分隔,例如:header-wrapper, main-content。

- 避免使用无意义的命名,应该根据元素的作用和意义来命名。

3. JavaScript命名规范- 变量和函数名应该使用驼峰式命名法,即第一个单词的首字母小写,后面的单词的首字母大写,例如:firstName, getUserInfo。

- 常量名应该使用全大写字母,多个单词之间使用下划线“_”分隔,例如:MAX_NUM, API_URL。

- 类名应该使用帕斯卡命名法,即所有单词的首字母都大写,例如:Person, UserService。

4. 图片命名规范- 图片命名应该使用有意义的名词或描述性的名词短语,多个单词之间使用连字符“-”分隔,例如:logo.png, slide-image.jpg。

5. URL命名规范- URL路径应该使用小写字母,多个单词之间使用连字符“-”分隔,例如:/news-list, /contact-us。

6. Git分支和提交规范- Git分支名应该使用有意义的名词或描述性的名词短语,多个单词之间使用连字符“-”分隔,例如:feature/login,hotfix/bug-fix。

- Git提交消息应该简明扼要地描述所做的更改,可以包括关键词和操作,例如:Add login form validation, Fix broken link。

WEB前端开发代码使用要求规范

WEB前端开发代码使用要求规范

WEB前端开发代码使用要求规范1.编码规范- 使用标准的HTML、CSS和JavaScript语法。

-使用缩进和空格来提高代码的可读性。

-使用注释来解释代码的目的和功能。

2.文件和目录结构规范-使用有意义的文件和目录命名,方便其他开发人员寻找代码。

-在项目中使用统一的目录结构,例如将HTML文件存放在一个文件夹中,将样式文件存放在另一个文件夹中,以此类推。

3.HTML规范- 避免在HTML中直接写入样式和脚本代码,应将样式和脚本代码分离到对应的CSS和JavaScript文件中。

4.CSS规范-使用适当的选择器,避免过多的嵌套。

-避免使用内联样式,应将样式写在CSS文件中,以提高可维护性。

- 使用合适的样式命名规则,例如使用BEM(Block-Element-Modifier)命名规则,或其他约定俗成的命名规则。

5. JavaScript规范-使用合适的变量和函数命名,提高代码的可读性。

-避免使用全局变量,应将变量和函数封装在模块中。

- 使用严格模式(`use strict`),避免不规范的语法和行为。

- 避免使用`eval`和`with`等不安全的代码。

-在循环中使用合适的终止条件,避免死循环。

6.代码结构规范-代码应具有良好的组织结构,例如使用模块化的方式来组织代码。

-尽量遵循单一职责原则,每个函数和类应该只负责一件事情。

-提取重复的代码块,封装成函数或类,以提高代码的复用性。

-不要写过长的函数或类,应该根据需要进行拆分和重构。

7.注释规范-使用注释来解释代码的目的和功能,特别是代码的复杂部分。

-注释应该清晰、简洁,方便其他开发人员理解代码。

-避免使用无用的注释,注释应该随着代码的变化而更新。

总之,遵守WEB前端开发代码使用要求规范能够提高代码的质量和开发效率,减少错误和维护成本。

同时,还能提高团队合作的效率,方便其他开发人员理解和修改代码。

因此,在进行WEB前端开发时应该积极遵守和推崇相关规范。

css命名规范

css命名规范

css命名规范CSS(层叠样式表)技术一直是Web开发者们进行前端开发的重要工具之一。

它可以为网页提供美观的外观,并且也可以提升网站的可用性。

在进行前端开发时,对于CSS文件定义和命名是一个非常重要的环节。

给CSS文件定义一个有意义的名字,可以帮助开发者理解文件的作用,以及里面定义的样式。

CSS文件的命名有不同的规范,这些规范的重要性不容忽视。

有意义的命名规范不仅可以帮助开发者在未来能够快速定位文件,而且也可以更加有效的维护网站的可读性。

下面将介绍几种常用的CSS命名规范。

1.写字母和数字组合:一种命名规范是使用最多的。

它非常简洁,便于区分。

通常使用小写字母和数字组合来命名CSS文件和样式,并且使用横线(-)做为连接符。

比如:style-sheet.css,button-style.css,footer-style.css等。

2. 使用驼峰式命名:峰式的命名法是一种英文单词的写法,它由单词的第一个字母小写开始,而每个单词的首字母都大写开始。

比如:styleSheet.css,buttonStyle.css,footerStyle.css等。

3. 使用短横线分隔:种命名方式使用了一个短横线将CSS文件和样式分隔,并且使用小写字母和数字组合命名CSS样式。

比如:style-sheet_button.css,style-sheet_footer.css等。

4. 使用下划线分隔:与前一种方式类似,这种方式也是使用小写字母和数字组合命名CSS样式,只是使用下划线(_)做为分隔符。

比如:style_sheet_button.css,style_sheet_footer.css等。

基本上,NASA等大型机构制定的CSS命名规范会以上述四种规范为主,有时会结合多种规范使用,以满足CSS文件的苛刻要求。

下面着重介绍一些常见的CSS命名规范。

1.名时尽量使用有意义的名称:命名时,尽量使用有意义的名称,而不是简单的数字或者字母。

前端开发规范文档

前端开发规范文档

前端开发规范文档规范目的为提高团队协作效率,便于后端开发人员添加功能及前端后期优化维护,输出高质量的代码,特制定该文档。

本规范文档一经确认, 前端开发人员必须按本文档规范进行前端开发。

本文档如有不对或者不合适的地方请及时提出。

经讨论决定后方可更改。

基本准则符合web标准,语义化html,结构表现行为分离,兼容性优良。

页面性能方面,代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度。

一、html 文件命名及编写规范1、命名规则采用小写英文字母|| _的组合命名,菜单名_功能名称,后缀.html。

如:manage_list.html(管理列表)、manage_add.html(新增)、manage_edit.html(修改)、manage_detail.html(详情)。

同时将页面放在其对应的模块划分目录中。

2、编写规范:(1)文档类型声明及编码统一为html5声明类型“<!DOCTYPE html>”;(2)编码统一为<meta charset="utf-8" />, 书写时利用IDE实现层次分明的缩进;(3)区域块、功能组件以及需要标注的地方,插入注释。

(4)在布局文件结构时,应遵循语义化标签(该用p不要用div、该用ul、li不要用p,h标签应根据标题层级合理利用)、代码结构简单、清晰明了,少用标签、少套结构(一段结构布局中 1个标签能解决的不要用2个,套2层结构能解决的不要套3层)的基本原则。

代码标签、结构嵌套示例:目标效果图代码结构嵌套<ul><li><h4>罗田县九资河徐冲药材</h4><img src=”***.jpg”><div><h3>茯苓</h3><p>小丁</p><p class=”color_red”>32元/公斤</p></div></li></ul>代码分析:根据目标效果图,实现的代码部分别使用了ul/li /h4/ img /div /h3/ p 这些标签。

WEB前端开发规范

WEB前端开发规范

WEB前端开发规范WEB前端开发规范WEB前端开发规范目录1、规范目的2、基本准则3、文件规范4、文件规范5、html书写规范6、css书写规范7、JavaScript书写规范8、图片规范9、注释规范10、开发及测试工具约定11、其他规范12、CSSHack1规范目的为提高团队协作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,同是为网站有一个更好的前端架构,网站的发展及未来打好一个基础。

本文档如有不对或者不合适的地方请提出来,基本准则符合web标准,语义化html,结构表现行为分离,兼容性优良.页面性能方面,代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度.文件规范3.1、html,css,js,images文件均归档至约定的目录中;23 3.2、html文件命名:命名以中文命名,依实际模块命名,如果同一模块以_&title&_来组合命名,以方便添加功能时查找对应页面,团结里的相互理解。

例如:我的好股网里的TAB命名大模块名称_小模块的titile.html我的好股网_关注的微博.html3.3、css文件命名:英文命名,后缀.css.初始化样式reset.css,其他样式依实际模块页面需求命名,共用样式一般以模块考虑来划分命名,如有改版修改的css文件可以采用&_时间日期例如:微博改版版块名称_时间日期.cssnew_blog_1212.css4.4、Js文件命名:英文命名,后缀.js.共用common.js,其他依实际模块需求命名.5.5、图片命名:4html书写规范4.1、文档类型声明及编码:统一用;编码统一为。

目的:统一性和网站提高开发合作效率。

4.2、非特殊情况下样式文件必须外链至之间;非特殊情况下JavaScript文件必须外链至页面底部之前;目的:网站的优化。

4.3、所有编码均遵循xhtml标准,标签&属性&属性命名必须由小写字母及下划线数字组成,且所有标签必须闭合,包括br(),hr()等;属性值必须用双引号包括;目的:更加符合web标准(w3c),也有利于seo。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

原则:整个项目的命名风格要统一,id说明特殊性,class说明普遍性。

从模块重用和节约文件体积的角度看,建议id类应尽量减少使用。

class类的命名向模块化发展。

命名风格:
常见的命名风格有:1.分隔线 css-style(不推荐);2.下划线 css_style(次推荐);3.驼峰式 cssStyle(主推荐)。

没有强制一定用哪种风格,不过同个项目中最好只使用一种风格,除非想表达特殊作用的再用多种风格,但要写好注释说明。

好的命名规范也能体现出语义化。

id 和class:
什么时候用id,什么时候用class没有一个绝对的说法。

这里只是提供一个参考。

对于页面的各个结构外层或者特殊部分(比如页面的布局,各个栏目),用id 来说明这个区域是什么内容。

对于页面中可重用的结构或者一些常用的从属结构(比如栏目中的标题,文章,列表等),用class来说明这个小块是什么,表现怎么样。

约定:搜索search不加bar修饰, 比如左边搜索区域, 命名为: searchL。

以此类推, L(左边), R(右边), T(上方), B(下方)。

不管任何模块, 为避开css 过多的命名名称, 比如选项卡tab的标题区域, 用hd命名, 写法为:" .tab .hd " 所有模块, 全部采用hd和bd模式。

另外, 用"Tb"代表表格的缩写,比如表单表格: formTb。

所有css命名采用Java的命名规范, 既是驼峰式的命名方式, 比如"newsList"。

大量模块使用雅虎的hd和bd命名思想(见‘CSS 书写’ 部分),将内层的css类命名简化,减少起名字的次数。

最好不要用id类定义html的模块外观,id类的唯一性比特殊。

比如在两个div中,用了相同的 id,js拿id 交互便会出现问题。

!
当我们采用下划线 _ 方式命名的时候在Dreamweaver等工具中双击,即可全选命名。

而采用分割线 - 命名时双击选取只能选中分割的一部分。

本文档来自宝来网按照行业从业经验编写,转载请注明:宝来网。

相关文档
最新文档