前端代码标准规范.docVIP

前端开发规范 基础准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简练明了有序, 尽可能减小服务器负载, 确保最快解析速度. 二、文件规范 1. html, css, js, images文件均归档至约定目录中; 2. html文件命名: 英文命名, 后缀.html. 同时将对应界面稿放于同目录中, 若界面稿命名为汉字, 请重命名和html文件同名, 以方便后端添加功效时查找对应页面; 3. css文件命名: 英文命名, 后缀.css. 共用global.css, 首页index.css, 其它页面依实际模块需求命名.; 4. Js文件命名: 英文命名, 后缀.js. 共用global.js, 其它依实际模块需求命名. 书写规范 HTML 基础架构请参考 template.html,移动端参考 template-mobile.html 1. 文档类型申明及编码: 统一为html5申明类型!DOCTYPE HTML; 编码统一为meta charset=utf-8 /, 书写时利用IDE实现层次分明缩进; 2. 非特殊情况下样式文件必需外链至head/head之间;非特殊情况下JavaScript文件必需外链至页面底部; 3. 引入样式文件或JavaScript文件时, 须略去默认类型申明. CSS:link rel=”stylesheet” href=”css/global.css” / JS:script src=js/jquery.js/script 4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.7.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js; 5. 全部编码均遵照xhtml标准, 标签 属性 属性命名 必需由小写字母及中、下划线数字组成, 且全部标签必需闭合; 属性值必需用双引号包含; 6. 充足利用无兼容性问题html本身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性时候, 首先要考虑下有没有默认已经有适宜标签去设置, 假如没有, 能够使用须以”data-”为前缀来添加自定义属性，避免使用”data:”等其它命名方法; 7. 语义化html, 如 标题依据关键性用h(同一页面只能有一个h1), 段落标识用p, 列表用ul, 内联元素中不可嵌套块级元素; 8. 尽可能降低div嵌套 9. 书写链接地址时, 必需避免重定向，比如：href=””, 即须在URL地址后面加上“/”； 10. 在页面中尽可能避免使用style属性,即style=”…”; 11. 能以背景形式展现图片, 尽可能写入css样式中; 12. 关键图片必需加上alt属性; 给关键元素和截断元素加上title; 13. 给区块代码及关键功效(比如循环)加上注释, 方便后台添加功效; 14. 特殊符号使用: 尽可能使用代码替换: 比如 () () 空格( ) ?(?) 等等; 15. 书写页面过程中, 请考虑向后扩展性; ? CSS 重置样式引用 reset.css 1. 编码统一为utf-8; 2. class和id使用: id是唯一, class是能够反复, 所以id尽可能使用在大模块上, class可用在反复使用率高及子级中; 常见命名： 容 器：container/box 头 部：header 主 导 航：nav 子 导 航：nav-sub 顶 导 航：nav-top 网站标志：logo 大 广 告：banner 页面中部：main 底 部：footer 菜 单：menu 菜单内容：menu-content 子 菜 单：menu-sub 搜 索：search 搜索关键字：keyword 搜索范围：range 标签文字：tag-title 标签内容：tag-content 目前标签：tag-active 标　 题：title 内 容：content 列 表：list 目前位置：nav-dir 侧 边 栏：side 图 标：icon 注 释：note 登 录：login 注 册：register 3. 为JavaScript预留钩子命名, 请以 js_ 起始, 比如: js_hide, js_show; 4.class和id命名:大框架命名比如header/footer/wrapper/left/right.其它样式名称由 小写英文 数字 - 来组合命名, 如top-comment, fontred, width200; 避免使用汉字拼音, 尽可能使用简易单词组合; 总而言之, 命名要语义化, 简明化. 5