关于html和CSS以及JavaScript前端命名规范的详解

无意发现自己文件夹里面有这么一个文件,具体从哪里来的不记得了,仔细看下,发现总结的挺好的,贴出来分享一下。

无论是从技术角度还是开发视角,对于web前端开发规范文档都有一定规范,本文就css3和html5的发展前景总结了一系列的web开发文档,仅供大家参考。

规范目的:

为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.

基本准则:

立即学习“Java免费学习笔记(深入)”;

符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.

文件规范

1. html, css, js, images文件均归档至约定的目录中;

2. html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;

3. css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.;

4. Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名.

html书写规范

1. 文档类型声明及编码: 统一为html5声明类型; 编码统一为, 书写时利用IDE实现层次分明的缩进;

2. 非特殊情况下样式文件必须外链至…之间;非特殊情况下JavaScript文件必须外链至页面底部;

3. 引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下:

4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js;

5. 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (
), hr()等; 属性值必须用双引号包括;

6. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:”等其他命名方式;

7. 语义化html, 如 标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;

8. 尽可能减少p嵌套, 如

欢迎访问XXX, 您的用户名是

用户名

完全可以用以下代码替代:

欢迎访问XXX, 您的用户名是用户名

;

9. 书写链接地址时, 必须避免重定向,例如:href=”http://itaolun.com/”, 即须在URL地址后面加上“/”;

10. 在页面中尽量避免使用style属性,即style=”…”;

11. 必须为含有描述性表单元素(input, textarea)添加label, 如

姓名:

须写成:

12. 能以背景形式呈现的图片, 尽量写入css样式中;

13. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;

14. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;

15. 特殊符号使用: 尽可能使用代码替代: 比如 (>) & 空格( ) & ?(?) 等等;

16. 书写页面过程中, 请考虑向后扩展性;

17. class & id 参见 css书写规范.

css书写规范

1. 编码统一为utf-8;

2. 协作开发及分工: i会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构&表现&行为; 共用css文件base.css由i书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改;

3. class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中; id原则上都是由我分发框架文件时命名的, 为JavaScript预留钩子的除外;

4. 为JavaScript预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show;

5. class与id命名: 大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式名称由 小写英文 & 数字 & _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.

6. 规避class与id命名(此条重要, 若有不明白请及时与i沟通):

a, 通过从属写法规避, 示例见d;

b, 取父级元素id/class命名部分命名, 示例见d;

c, 重复使用率高的命名, 请以自己代号加下划线起始, 比如i_clear;

d, a,b两条, 适用于在2中已建好框架的页面, 如, 要在2中已建好框架的页面代码

中加入新的p元素,

按a命名法则:

,

样式写法: #mainnav .firstnav{…….}

按b命名法则:

,

样式写法: .main_firstnav{…….}

7. css属性书写顺序, 建议遵循 布局定位属性–>自身属性–>文本属性–>其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: margin & padding & float(包括clear) & position(相应的 top,right,bottom,left) & display & visibility & overflow等; 自身属性主要包括: width & height & background & border; 文本属性主要包括: font & color & text-align & text-decoration & text-indent等;其他属性包括: list-style(列表样式) & vertical-vlign & cursor & z-index(层叠顺序) & zoom等. 我所列出的这些属性只是最常用到的, 并不代表全部;

8. 书写代码前, 考虑并提高样式重复使用率;

9. 充分利用html自身属性及样式继承原理减少代码量, 比如:

这儿是标题列表2010-09-15

定义

ul.list li{position:relative} ul.list li span{position:absolute; right:0}

即可实现日期居右显示

10. 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;

11. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;

12. 使用table标签时(尽量避免使用table标签), 请不要用width/ height/cellspacing/cellpadding等table属性直接定义表现, 应尽可能的利用table自身私有属性分离结构与表现, 如

thead,tr,th,td,tbody,tfoot,colgroup,scope; (cellspaing及cellpadding的css控制方法: table{border:0;margin:0;border-collapse:collapse;} table th, table td{padding:0;} ,

base.css文件中我会初始化表格样式)

13. 杜绝使用 兼容ie8;

14. 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:

_background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src=’img/bg.png’);

15. 避免兼容性属性的使用, 比如text-shadow || css3的相关属性;

16. 减少使用影响性能的属性, 比如position:absolute || float ;

17. 必须为大区块样式添加注释, 小区块适量注释;

18. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化i会统一处理;

JavaScript书写规范

1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || …);

2. 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;

3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;

jQuery变量要求首字符为’_’, 其他与原生JavaScript 规则相同, 如: _iTaoLun;

另, 要求变量集中声明, 避免全局变量.

4. 类命名: 首字母大写, 驼峰式命名. 如 ITaoLun;

5. 函数命名: 首字母小写驼峰式命名. 如iTaoLun();

6. 命名语义化, 尽可能利用英文单词或其缩写;

7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;

8. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;

9. 代码结构明了, 加适量注释. 提高函数重用率;

10. 注重与html分离, 减小reflow, 注重性能.

 

图片规范

1. 所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;

2. 图片格式仅限于gif || png || jpg;

3. 命名全部用小写英文字母 || 数字 || _ 的组合,其中不得包含汉字 || 空格 || 特殊字符;尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif;

4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;

5. 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);

6. 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.

 

注释规范

1. html注释: 注释格式 , ’–’只能在注释的始末位置,不可置入注释文字区域;

2. css注释: 注释格式 /*这儿是注释*/;

3. JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用 /* 这儿有多行注释 */;

 

开发及测试工具约定

建议使用Aptana || Dw || Vim , 亦可根据自己喜好选择, 但须遵循如下原则:

1. 不可利用IDE的视图模式’画’代码;

2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;

3. 编码必须格式化, 比如缩进;

测试工具: 前期开发仅测试FireFox & IE6 & IE7 & IE8 , 后期优化时加入Opera & Chrome & Safari;

建议测试顺序: FireFox–>IE7–>IE8–>IE6–>Opera–>Chrome–>Safari, 建议安装firebug及IE Tab Plus插件.

其他规范

1. 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;

2. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.

以上就是关于html和CSS以及JavaScript前端命名规范的详解的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1544798.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月21日 16:14:13
下一篇 2025年12月21日 16:14:25

相关推荐

  • html中关于img标签以及改变图片尺寸的详解(图)

    1、统一大小? 我的网页上面有许多的图片,有的大,有的小,我想如果图片大的实现缩放,所有的都是一般大。来看看没有是什么效果。 大家看的出来,非常的难看的,于是我想让有没有一种方法是把那个大的变成小的呢? @@##@@ 效果图如下: 立即学习“前端免费学习笔记(深入)”; 但是如果图片太小了呢?就会被…

    2025年12月21日
    000
  • Html中关于空格的各种显示详解

    一、使用全角空格 全角空格被解释为汉字,所以不会被被解释为HTML分隔符,可以按照实际的空格数显示。 二、使用空格的替代符号 替代符号就是在需要显示空格的地方加入替代符号,这些符号会被浏览器解释为空格显示。 空格的替代符号有以下几种: 立即学习“前端免费学习笔记(深入)”; 名称编号描述  不断行的…

    2025年12月21日
    000
  • 关于html中空格的问题解决

    联系我们 联系我们 联系我们 上边三种写法图标和文字的距离为什么都不一样?和inline-block的图标和换行有关系吗?如果我换5行 联系我们 联系我们 上边两种效果是一样的,为什么呢? 联系我们 nasp和实际打出来的空格效果是一样的为什么还要用nbsp呢? 联系我们 联系我们 像这种1个空格1…

    好文分享 2025年12月21日
    000
  • html与CSS如何实现圆形和圆角图片格式的示例代码

    效果展示 实现代码 < JcMan .image1{ margin-top: 100px; width:200px; height:200px; border-radius:200px; } .image2{ margin-top: 100px; width:200px; height:200…

    2025年12月21日
    000
  • html中如何嵌入特殊字体中文以及英文的实例

    英文字体引入方法: html代码 @font-face { font-family: ‘fontNameRegular’; /* 字体名称,可自己定义 */ src: url(‘LIGHRG.eot’); src: local(‘fontName Regular’), local(‘Lightnin…

    好文分享 2025年12月21日
    000
  • 关于html页面中怎样实现中英文切换的实例分享

            如何实现html页面的双语切换呢?最粗暴的办法是做两个页面,一个中文的,一个英文的。稍微温和的方法是:在每次显示之前,对当前的语言标志进行判断,用if和else来解决,其实,这种办法虽然没有那么粗暴,但也够恶心的了。还是用其他办法吧,废话少说,直接上代码。        为了简便起见…

    好文分享 2025年12月21日
    000
  • html中关于charset的语言编码详解

    注意html的语言编码的重要性 目录 charset编码重要性 charset在html什么地方 charset标签 立即学习“前端免费学习笔记(深入)”; 编码种类 charset utf-8介绍 charset GB2312介绍 推荐网页编码 因编码导致网页兼容 一、编码重要性   &#8211…

    好文分享 2025年12月21日
    000
  • html页面中如何将编码转换成中文的示例代码

    html页面中如何将编码转换成中文的示例代码 private static String convertToChinese(String dataStr) { System.out.println(“——–data str—->” + dataStr); if(dataStr =…

    好文分享 2025年12月21日
    000
  • 如何去掉html中超链接下划线的实例

    我们可以用css语法来控制超链接的形式、颜色变化。   下面我们做一个这样的链接:未被点击时超链接文字无下划线,显示为蓝色;当鼠标在链接上时有下划线,链接文字显示为红色;当点击链接后,链接无下划线,显示为绿色。   实现方法很简单,在源代码的 和之间加上如下的CSS语法控制:   

    好文分享 2025年12月21日
    000
  • html中关于form表单submit和button的提交用法详解

    1.当输入用户名和密码为空的时候,需要判断。这时候就用到了校验用户名和密码,这个需要在jsp的前端页面写;有两种方法,一种是用submit提交。一种是用button提交。方法一:在jsp的前端页面的头部插入一个js方法: function checkUser(){ var result = docu…

    好文分享 2025年12月21日
    000
  • html中如何实现使用图像来代替提交按钮的示例

    1. 用图像代替提交按钮      当只有一个提交按钮的时候 ,可以简单的实现,不用添加事件函数,代码是:  除了标签改为input type = “image”以外,其他的属性和标签的属性是一样的。 2.用图片代替所有的表单按钮 代替submit按钮的图片格式是 立即学习“前端免费学习…

    好文分享 2025年12月21日
    000
  • html中的textarea属性大全(设置默认值 高度自适应 获取内容 限制输入字数 placeholder)

    1.textarea设置默认值 HTML:  此段代码设置一个textarea文本框 并且设置为隐藏 2.textarea高度自适应 今天需要些一个回复评论的页面,设计师给的初始界面就是一个只有一行的框。然后当时就想这个交互该怎么实现比较好,然后想起了新浪微博的做法:点击评论,默认显示一行,当输入的…

    2025年12月21日
    000
  • html中关于iframe如何嵌套网页的实例分析

    把iframe嵌套的网页放在某一位置,只需在iframe外加个框,改变框的位置即可,如:   css如下: *{ padding: 0; margin: 0;} body{background: green} .main{ width: 80%; height: 500px; margin: 0 a…

    2025年12月21日
    000
  • html中textarea输入框提示文字必须添加默认内容的完美解决

    完美解决textarea输入框提示文字,必须添加默认内容 有placeholder标签,可以添加提示文字 ,但是没有,一般来说我们是把提示内容写在外面,如下图: 当然,这样的布局并不是最想要的效果, 最想要的是文字显示在输入框内,点击输入框时隐藏,离开输入框时,如果输入框没有内容,又显示提示: 网上…

    2025年12月21日
    000
  • 实例介绍六种html清除浮动的方式,供参考

    使用display:inline-block会出现的情况: 1.使块元素在一行显示2.使内嵌支持宽高3.换行被解析了4.不设置的时候宽度由内容撑开5.在IE6,7下步支持块标签由于inline-block属性换行的时候被解析(有间隙)故解决方法使用浮动float:left/right使用浮动时出现的…

    好文分享 2025年12月21日
    000
  • html中的链接如何默认打开方式标签元素的详解

    html 超链接(锚文本)默认打开方式与默认链接url地址标签元素 一、语法与结构 二、Html base超链接默认打开地址与打开方式标签使用说明    1、Target 值:    1、_blank 新窗口打开URL链接    2、_parent 在本网页刷新全新打开对应URL地址    3、_s…

    好文分享 2025年12月21日
    000
  • Html中关于字体大小单位px、em、 pt的具体分析

    网页上定义字体大小有常见三种单位,px、em、pt px px是pixel缩写,是基于像素的单位.在浏览网页过程中,屏幕上的文字、图片等会随屏幕的分辨率变化而变化,一个100px宽度大小的图片,在800×600分辨率下,要占屏幕宽度的1/8,但在1024×768下,则只占约1/10。所以如果在定义字…

    好文分享 2025年12月21日
    000
  • html中标签的实例解析

    html 文本颜色 字体 大小标签元素 html 标签之html文字字体、html字体颜色、html字体大小设置标签元素 目录 font标签语法与结构 html Font标签说明 Font应用案例 立即学习“前端免费学习笔记(深入)”; font标签案例截图 font标签总结 一、font标签语法与…

    2025年12月21日
    000
  • html中关于iframe的allowTransparency属性的详解

    ie5.5开始支持浮动框架的内容透明。如果想要为浮动框架定义透明内容,则必须满足下列条件。1.与 iframe 元素一起使用的 allowtransparency 标签属性必须设置为 true。2.在 iframe 内容源文档,background-color 或 body 元素的 bgcolor …

    好文分享 2025年12月21日
    000
  • html iframe使用的实战总结分享

    说在前面的话,iframe是可以做很多事情的。例如:a>通过iframe实现跨域;b>使用iframe解决ie6下select遮挡不住的问题c>通过iframe解决ajax的前进后退问题d>通过iframe实现异步上传。(easyui中form组件就是用的iframe,实现表…

    2025年12月21日 好文分享
    000

发表回复

登录后才能评论
关注微信