前端代码编写规范

上传人:夏** 文档编号:468195344 上传时间:2023-03-07 格式:DOC 页数:20 大小:133KB
返回 下载 相关 举报
前端代码编写规范_第1页
第1页 / 共20页
前端代码编写规范_第2页
第2页 / 共20页
前端代码编写规范_第3页
第3页 / 共20页
前端代码编写规范_第4页
第4页 / 共20页
前端代码编写规范_第5页
第5页 / 共20页
点击查看更多>>
资源描述

《前端代码编写规范》由会员分享,可在线阅读,更多相关《前端代码编写规范(20页珍藏版)》请在金锄头文库上搜索。

1、前端代码编写规范命名规则1. 项目名称项目名称驼峰式命名.例:myProject2. 目录命名采用单数命名法.例:css img font js3. JS文件命名字母全部小写,单词之间用-.例:popup-window.js4. CSS文件命名字母全部小写,单词之间用-.例:popup-window.css5. HTML文件命名文件名称驼峰式命名.例:riverMonitor.htmlHTML1. 语法缩进使用Tab4个空格;解释:对于非HTML标签之间的缩进,比如script或style标签内容缩进,与script或style标签的缩进同级./* 样式内容的第一级缩进与所属的 style 标

2、签对齐 */ul padding: 0; first second/ 脚本代码的第一级缩进与所属的 script 标签对齐requireapp, function app.init;嵌套的节点应该缩进;在属性上使用双引号字符串拼接除外;属性名全小写,用-做分隔符;自动闭合标签处不能使用斜线.Page titleHello, world!2. HTML5 doctype页面开头的doctype大写,html小写.例:.3. 字符编码采用UTF-8的编码格式.例: .4. 引入CSS,JSCSS引入使用JS 引入使用页面不允许出现style标签.5. 属性1. 属性名必须使用小写字母./table

3、2. 属性值必须使用双引号包围不允许使用单引号.6. 属性顺序classidnamedata-*src,for,type,href,value,max-length,max,min,patternplaceholder,title,altaria-*,rolerequired,readonly,disabled7. 标签标签名必须使用小写字母Hello StyleGuide!Hello StyleGuide!1对于无需自闭合的标签,不允许自闭合解释:常见无需自闭合标签有 input、br、img、hr 等.2. 标签使用必须符合标签嵌套规则解释:比如div不得置于p中,tbody必须置于tab

4、le中.ul 标签包含着 li、dl 标签包含着 dt 和 dd.3. 标签使用必须符合标签嵌套规则常见标签语义:P段落h1,h2,h3,h4,h5,h6层级标题strong,em强调ins插入del删除abbr缩写code代码标识cite引述来源作品的标题q引用blockquote一段长篇引用ul无序列表 ol有序列表dl,dt,dd定义列表8. 图片禁止img的src取值为空.延迟加载的图片也要增加默认的src.解释:src取值为空,会导致部分浏览器重新加载一次当前页面,参考:ahoo /performance/rules.html#emptysrc建议 避免为img添加不必要的title

5、属性.解释:多余的title影响看图体验,并且增加了页面尺寸.建议 为重要图片添加alt属性.解释:可以提高图片加载失败时的用户体验.建议 添加width和height属性,以避免页面抖动.建议 有下载需求的图片采用img标签实现,无下载需求的图片采用 CSS 背景图实现.解释:1. 产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片,以img形式实现,能方便用户下载.2. 无下载需求的图片,比如:icon、背景、代码使用的图片等,尽可能采用 CSS 背景图实现.9. 表单1控件标题强制 有文本标题的控件必须使用label标签将其与其标题相关联.解释:有两种方式:1. 将控件置于l

6、abel内.2. label的for属性指向控件的id.推荐使用第一种,减少不必要的id.如果 DOM 结构不允许直接嵌套,则应使用第二种.示例: 我已确认上述条款用户名: 2按钮强制 使用button元素时必须指明type属性值.解释:button元素的默认type为submit,如果被置于form元素中,点击后将导致表单提交.为显示区分其作用方便理解,必须给出type属性.示例:提交取消建议 尽量不要使用按钮类元素的name属性.解释:由于浏览器兼容性问题,使用按钮的name属性会带来许多难以发现的问题.具体情况可参考此文.3可访问性 建议 负责主要功能的按钮在 DOM 中的顺序应靠前.解

7、释:负责主要功能的按钮应相对靠前,以提高可访问性.如果在 CSS 中指定了float: right则可能导致视觉上主按钮在前,而 DOM 中主按钮靠后的情况.示例:.buttons.button-group float: right; 提交 取消 .buttonsbutton float: right; 取消 提交建议 当使用 JavaScript 进行表单提交时,如果条件允许,应使原生提交功能正常工作.解释:当浏览器 JS 运行错误或关闭 JS 时,提交功能将无法工作.如果正确指定了form元素的action属性和表单控件的name属性时,提交仍可继续进行.示例: 建议 在针对移动设备开发的

8、页面时,根据内容类型指定输入框的type属性.解释:根据内容类型指定输入框类型,能获得能友好的输入体验.示例:10. 多媒体建议 当在现代浏览器中使用audio以与video标签来播放音频、视频时,应当注意格式.解释:音频应尽可能覆盖到如下格式: MP3 WAV Ogg视频应尽可能覆盖到如下格式: MP4 WebM Ogg建议 在支持HTML5的浏览器中优先使用audio和video标签来定义音视频元素.建议 使用退化到插件的方式来对多浏览器进行支持.示例: 建议 只在必要的时候开启音视频的自动播放.建议 在object标签内部提供指示浏览器不支持该标签的说明.示例:DO NOT SUPPORT THIS TAG11. js生成标签在js文件中生成标签让内容更难查找,更难编辑,性能更差,应该尽量避免这种情况的出现12. 减少标签数量

展开阅读全文
相关资源
相关搜索

当前位置:首页 > 建筑/环境 > 施工组织

电脑版 |金锄头文库版权所有
经营许可证:蜀ICP备13022795号 | 川公网安备 51140202000112号