WEB前端开发规范文档

合集下载

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.代码注释规范-使用注释来说明代码的用途和作用;-使用块注释来注释一整段代码,使用行注释来注释一行代码。

WEB前端开发规范文档

WEB前端开发规范文档

WEB前端开发规范文档目录WEB前端开发规范文档 (1)规范目的 (2)基本准则 (2)文件规范 (2)html书写规范 (2)html其他规范 (3)css书写规范 (4)JavaScript书写规范 (5)jQuery部分 (5)开发及测试工具约定 (6)其他规范 (6)规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档: 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发: 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改:基本准则1:符合web标准, 语义化html,遵循内容(HTML)、显示(CSS)、行为(JavaScript)分离的代码组织模式。

2:代码格式化,保持干净整洁。

3:换行必须缩进一个tab。

4:编写所有前台页面时,请使用已有模板进行复制,在模板的基础上进行开发。

5:每一个页面都必须有一个独立的css,js文件。

6:如果不是用HTML5编写的网站,请用IE7,IE8,IE9,火狐,谷歌,webkit,safari内核进行测试兼容性。

7:如果是HTML5编写的网站,请用IE9,火狐,谷歌,webkit,safari内核进行测试兼容性。

文件规范1: html, css, js, images文件均归档至<系统开发规范>约定的目录中;2: html文件命名: 英文命名, 后缀:htm: 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面;3: css文件命名: 英文命名, 后缀:css: 共用base:css, 首页index:css, 其他页面依实际模块需求命名:;4: Js文件命名: 英文命名, 后缀:js: 共用common:js, 其他依实际模块需求命名:html书写规范1:所有元素都必须小写,属性也是,如: <input type=”text”id=”idName”/>正确<INPUT TYPE=”text”ID=”idName”/>错误2:元素必须成对出现,如<span>必须写成<span></span>特殊元素除外,如:<br /><hr /><img /><input />3:标签中不允许出现样式,必须用class来声明样式,如:<input type=”text”id=”idName”style=”text-align:right;”/>错误<input type=”text”id=”idName”class=”class-name”/>正确4:元素id命名必须是驼峰式命名如:<input type=”text”id=”idName”/>正确<input type=”text”id=”idname”/>错误<input type=”text”id=”id-name”/>错误5:元素class命名规范是:元素简写+”-”+功能名,如:<button calss=”btn-save”></button>正确<button calss=”btnSave”></button>错误<button calss=”save”></button>错误6:元素name命名必须遵循驼峰式命名法。

Web前端开发规范文档

Web前端开发规范文档

Web前端开发规范文档规范目的:•使开发流程更加规范化。

通用规范:•TAB键用两个空格代替(WINDOWS下TAB键占四个空格,LINUX下TAB键占八个空格)。

•CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。

•文件内容编码均统一为UTF-8。

•CSS、JAVASCRIPT中的非注释类中文字符须转换成unicode 编码使用, 以避免编码错误时乱码显示。

文件规范:•文件名用英文单词,多个单词用驼峰命名法。

•一些浏览器会将含有这些词的作为广告拦截,文件命名、ID、CLASS等所有命名避免以上词汇。

html书写规范:•为每个HTML页面的第一行添加标准模式(standard mode)的声明,确保在每个浏览器中拥有一致的展现。

<!DOCTYPE html>•文档类型声明统一为HTML5声明类型,编码统一为UTF-8。

<meta charset="UTF-8">•<HEAD>中添加信息。

<meta name="author"content="smile@kang.cool">//作者•<meta name="description" content="hello">//网页描述•<meta name="keywords" content="a,b,c">//关键字,“,”分隔•<meta http-equiv="expires" content="Wed, 26 Feb 1997 08:21:57 GMT">//设定网页的到期时间。

一旦网页过期,必须到服务器上重新调阅•<meta http-equiv="Pragma" content="no-cache">//禁止浏览器从本地机的缓存中调阅页面内容•<meta http-equiv="Window-target" content="_top">//用来防止别人在框架里调用你的页面•<meta http-equiv="Refresh"content="5;URL=/">//跳转页面,5指时间停留5秒网页搜索机器人向导。

前端开发规范文档

前端开发规范文档

前端开发规范文档一、概述。

本文档旨在规范前端开发工作,统一团队成员的开发风格,提高代码质量和可维护性。

在前端开发中,规范是非常重要的,它可以让团队成员之间的合作更加顺畅,代码更加易读易懂。

本规范文档将涵盖HTML、CSS、JavaScript等前端开发的相关规范,希望每位开发人员都能认真遵守。

二、HTML规范。

1. 文件命名规范。

文件名应使用小写字母,单词之间可以使用连字符“-”连接,例如,index.html、about-us.html。

文件名应简洁明了,不使用无意义的数字或字符。

2. 代码缩进规范。

使用两个空格进行代码缩进,不使用Tab键。

3. 标签规范。

标签名应使用小写字母。

标签属性值应使用双引号。

4. 注释规范。

在需要注释的地方使用<!--->进行注释。

5. 其他规范。

应尽量避免使用行内样式和行内脚本。

尽量减少标签的嵌套层级,保持HTML结构的简洁性。

三、CSS规范。

1. 文件组织规范。

将CSS文件统一放置在一个文件夹中,不要将CSS文件散落在各个目录中。

可以根据模块或页面的不同,将CSS文件拆分为多个文件,使用@import进行引入。

2. 类名规范。

类名应使用小写字母,单词之间可以使用连字符“-”连接,例如,header-nav、footer-content。

类名应简洁明了,不使用无意义的数字或字符。

3. 属性顺序规范。

CSS属性应按照一定的顺序书写,例如,布局定位属性、盒模型属性、文字排版属性、视觉效果属性等。

4. 其他规范。

尽量避免使用!important,除非必要情况下。

尽量使用缩写属性,减少代码量。

四、JavaScript规范。

1. 变量命名规范。

变量名应使用驼峰命名法,例如,myName、isShow。

变量名应简洁明了,不使用无意义的单个字母。

2. 代码缩进规范。

使用两个空格进行代码缩进,不使用Tab键。

3. 注释规范。

在需要注释的地方使用//进行单行注释,使用/ /进行多行注释。

WEB前端开发规范(可复制)

WEB前端开发规范(可复制)

WEB前端开发规范目录一.实现符合W3C的Web 标准 (3)1.1软件环境 (3)1.1.1制作软件 (3)1.1.2 测试软件 (3)1.2 网站架构的流程 (3)1.2.1设计稿的分析 (3)1.2.2切图 (4)1.2.3 XHTML和CSS的编写 (4)1.3 XHTM代码编写规范 (5)1.3.01 统一DOCTYPE (5)1.3.02 统一指定语言及字符集 (5)1.3.04 所有的标签都必须使用结束标记 (6)1.3.05 所有标签和属性名称都必须小写 (6)1.3.06 属性值必须使用双引号括起来 (6)1.3.07 不允许使用属性简写 (6)1.3.08 所有标签都必须合理嵌套 (7)1.3.09 特殊符号都用编码表示 (7)1.3.10 图片标签必须要有ALT属性 (7)1.3.11 注视的规范写法 (7)1.3.12 尽可能用id属性代替name属性 (7)1.3.13 尽量使用语义标签。

(8)1.4CSS代码编写规范 (8)1.4.01 规范相关注释 (8)1.4.02 调用样式的方法统一 (9)1.4.02 选择符命名采用驼峰式命名法 (9)1.4.03 不使用行内样式和页内样式 (9)1.4.03 正确的选择CLASS和ID (9)1.4.04 使用RESET 将默认的CSS 重置 (10)1.4.05 分离CSS可复用部分 (10)1.4.06 适当实用CSS HACK (10)1.4.07 CSS语法、书写格式符合规范 (10)1.4.08 属性有序的排列 (10)1.4.09 样式表组织统一 (11)1.4.10 其它相应规范 (11)二、XHTML元素的命名参考 (12)2.1布局页面的div id命名 (12)2.2页面的各种元素id 命名和class命名 (12)2.3常用的命名关键字 (13)一. 实现符合W3C 的Web 标准1.1软件环境 1.1.1制作软件使用Dreamweaver 和 Frontpage 等直接视图进行网页制作。

(完整word版)WEB前端开发代码使用要求规范.docx

(完整word版)WEB前端开发代码使用要求规范.docx

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

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

本文档如有不对或者不合适的地方请及时提出,经讨论决定后方可更改。

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

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

文件规范1.Html, css ,js ,images 文件均归档至相应约定的目录中。

cssimagesbackStagejs后台模⋯⋯cssWebRootimagesfrontStagejsWEB-INF前台模⋯⋯全局公共模⋯⋯2. html 文件命名:英文驼峰式命名,文件名.html 。

按实际模块需求命名。

3.jsp 文件命名:英文峰式命名,文件名 .jsp 。

按模需求命名。

4.css 文件命名:英文峰式命名,文件名 .css 。

共用 base.css ,首 index.css ,其他面按模需求命名。

5.js 文件命名:英文峰式命名,文件名 .js 。

共用 common.js,其他依模需求命名。

html 书写规范1. 文档型声明及:一html5的声明型<!DOCTYPE html>;一<meta charset="utf-8"/>,写利用IDE 次分明的。

2.非特殊情况下 css 文件必在 <head>...</head> 之引入, link 方式引入而非@import 形式。

3.非特殊情况下 js 文件必在面底部引入。

4.引入式文件或 JavaScript 文件,略去默型声明,写法如下:<link rel="stylesheet"href="..."/><style>...</style><script src="..."></script>5.引入 JS 文件,文件名包含名称及版本号及是否版,比如: jquery-1.4.1.min.js ;6.引入插件,文件名格式名称 +插件名称,比如: jQuery.cookie.js 。

前端开发设计规范文档

前端开发设计规范文档1.设计概述(200字)前端开发设计规范文档旨在为前端开发人员提供一套统一的设计规范,确保开发出的网页和应用具有高可读性、易维护性和跨浏览器兼容性。

本文档将涵盖HTML、CSS和JavaScript编码规范、文件结构规范、命名规范、注释规范等方面的内容。

2.文件结构规范(200字)为了确保项目的可维护性和可扩展性,文件结构规范起到了至关重要的作用。

在项目中,应该按照功能、模块或页面将文件进行划分,并使用合理的命名方式对文件进行命名。

目录结构应该清晰明了,新人可以迅速找到所需文件,并且易于扩展和维护。

3.HTML编码规范(300字)4.CSS编码规范(300字)CSS编码规范旨在统一样式代码的书写风格,方便团队成员的合作和代码维护。

应该遵循缩进、空格、换行等方面的规则,并为选择器、属性和值选择合适的命名方式。

另外,应该避免使用全局选择器、!important和浮动布局等容易引起样式冲突的属性和技术。

5. JavaScript编码规范(300字)JavaScript编码规范对于代码的可读性、可维护性和可扩展性有着重要的影响。

代码应该遵循统一的缩进和空格约定,并采用语义化的命名方式。

应该避免使用全局变量和隐式全局变量,同时对函数进行适当的封装和模块化处理。

另外,应该注重错误处理和代码注释,以便他人能够理解和维护代码。

6.命名规范(200字)良好的命名规范有助于团队成员理解代码的意图和结构。

在命名时应使用有意义的名词和动词,避免使用缩写和拼音,并使用统一的命名方式。

对于变量、函数、类和文件命名,应该遵循一定的命名约定,以提高代码的可读性和可维护性。

7.注释规范(200字)总结(100字)前端开发设计规范文档为前端开发人员提供了一套统一的设计规范,包括文件结构、HTML、CSS、JavaScript编码规范、命名规范和注释规范等方面的内容。

遵循这些规范将有助于提高代码的可读性、可维护性和跨浏览器兼容性,提高团队成员之间的合作效率。

WEB前端开发规范

WEB前端开发规范WEB前端开发规范一、命名规范1. HTML/CSS命名规范- 使用大写字母和小写字母的组合方式,不使用汉字、拼音或其他特殊字符。

- 使用有意义的命名,能够反映元素的用途或内容。

- 使用连字符"-"作为多个单词的分隔符。

- 避免使用复数形式命名。

2. JavaScript命名规范- 使用驼峰命名法,首字母小写。

- 类名首字母要大写。

- 命名要具有表达性,能明确表达出变量或函数的用途。

3. 图片命名规范- 使用有意义的命名,能够反映图片的内容或用途。

- 使用连字符"-"作为多个单词的分隔符。

- 图片命名中不要包含特殊字符或中文。

二、代码规范1. HTML规范- 使用语义化的标签,遵循W3C标准。

- 元素属性值使用双引号包裹。

- 缩进使用两个空格,不使用TAB键。

2. CSS规范- 尽量避免使用!important。

- 属性和值之间用一个空格隔开。

- 选择器和属性名使用全小写。

- 使用缩进和换行使代码具有良好的可读性。

3. JavaScript规范- 使用ESLint进行代码检查,并遵循检查结果进行修改。

- 使用分号结束语句。

- 使用const和let替代var。

- 使用模块化开发,避免全局变量的滥用。

4. 文件目录规范- 对于大型项目,建议按照模块和功能进行文件分层。

- 文件和文件夹命名要有意义,能够清晰表达文件的用途。

5. 注释规范- 对于重要的代码块、函数和类,添加必要的注释,解释其作用和用法。

- 注释要简洁明了,不要使用口语化的表达方式。

- 避免不必要或重复的注释。

三、性能优化1. CSS性能优化- 避免使用过多的样式表和多层嵌套。

合并和压缩CSS文件。

- 使用CSS Sprites合并图片。

- 避免使用纯色背景图片,使用CSS实现。

2. JavaScript性能优化- 代码压缩和合并,减少HTTP请求。

- 合理使用缓存,避免重复请求相同的数据。

入门资料:web前端开发规范

本文主要从以下几个方面来概述前端的开发规范1. 目录构建规范2. 前端命名规范3. 前端工作规范4. 开发文档的书写规范1. 前端目录构建规范我们从命名原则、根目录、业务逻辑等方面进行目录构建1.1 命名原则:- 简洁明了(如下:)* src 源代码* img 图片资源* js JavaScript脚本* dep 第三方依赖包- 不使用复数(如下:)* 不使用imgs docs1.2 根目录(root)结构按职能划分(如下:)- src 源代码(逻辑)- doc 文档- dep 第三方依赖包- test 测试1.3 根据业务逻辑进行文件夹的划分(如下:)- src目录名词解释:- common 公共资源- public/static 静态资源- component 组件- view/tpl 模板文件```srccommon 公共资源imglogo.pngsprites.pngcssreset.cssjsconf.js 项目的配置文件public/static 静态资源jscsstplindex.html shopcar.htmlimgcomponent 组件homeshopcarloginregisteruserlistdetailview/tpl 项目模板tpl 是template的缩写```1.4 总结:以上目录开发规范有两种使用途径1. 使用前端工程化工具如webpack、gulp等进行手动打造2. 利用框架提供的脚手架工具进行修改2. 前端命名规范这部分内容我从以下两个方面来进行讲解·CSS命名规范o BEM规范o OOCSS规范·javaScript编写规范o jslinto eslint2.1 css命名规范2.1.1 BEM规范- 概念:Block Element Modifier,它是一种前端命名方法,旨在帮助开发者实现模块化、可复用、高可维护性和结构化的CSS代码。

前端开发设计规范文档

前端开发设计规范文档1.前言前端开发是构建用户界面的过程,它的设计和编写需要遵循一定的规范,以保证代码的可读性、可维护性和可扩展性。

本文档旨在提供一个前端开发的设计规范,帮助开发人员在设计和编写前端代码时遵循统一的规范。

2.命名规范2.1文件和文件夹命名-文件名使用小写字母,单词之间可以使用连字符“-”连接。

-文件夹名同样使用小写字母,单词之间使用连字符“-”连接。

2.2变量和函数命名- 变量和函数名使用驼峰命名法,即第一个单词首字母小写,后面的单词首字母大写。

例如:userInfo, getUserInfo。

2.3CSS类命名- CSS 类名使用连字符“-”连接,例如:main-container, login-button。

3.HTML规范3.2嵌套规范-HTML元素的嵌套应该保持良好的层次结构,不要过深嵌套。

-使用缩进保持结构清晰,增加代码的可读性。

4.CSS规范4.1使用外部样式表-将CSS样式写在外部样式表中,使代码可重用和维护。

4.2避免使用行内样式-避免在HTML元素上使用行内样式定义样式。

4.3样式规则的书写顺序-将样式规则按照从上到下的顺序书写,以保持结构清晰。

-先定义通用样式,再定义特定样式。

-按照样式的属性顺序书写,例如先写字体相关,再写颜色相关。

4.4使用CSS预处理器-使用CSS预处理器(如SASS或LESS)来提高CSS代码的可维护性和可扩展性。

5. JavaScript 规范5.1使用严格模式- 在 JavaScript 文件的开头添加 "use strict" 来启用严格模式。

5.2使用语义化的命名-使用有意义的变量和函数名,易于理解和维护。

5.3避免全局变量和函数-尽量避免使用全局变量和函数,以减少命名冲突和代码污染。

5.4缩进和空白符-使用合适的缩进和空白符来增加代码的可读性。

5.5注释规范-使用注释解释代码的意图和功能。

-在复杂的代码块前添加注释,帮助其他开发人员理解代码逻辑。

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

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

规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.基本准则符合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声明类型<!DOCTYPE html>; 编码统一为<meta charset=”utf-8″ />, 书写时利用IDE实现层次分明的缩进;2. 非特殊情况下样式文件必须外链至<head>…</head>之间;非特殊情况下JavaScript文件必须外链至页面底部;3. 引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下:<link r el=”stylesheet” href=”…” /><style>…</style><script src=”…”></script>4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js;5. 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (<br />), hr(<hr />)等; 属性值必须用双引号包括;6. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性,避免使用”data:”等其他命名方式;7. 语义化html, 如标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;8. 尽可能减少div嵌套, 如<div class=”box”><div class=”welcome”>欢迎访问XXX, 您的用户名是<div class=”name”>用户名</div></div></div>完全可以用以下代码替代: <div class=”box”><p>欢迎访问XXX, 您的用户名是<span>用户名</span></p></div>;9. 书写链接地址时, 必须避免重定向,例如:href=”/”, 即须在URL地址后面加上“/”;10. 在页面中尽量避免使用style属性,即style=”…”;11. 必须为含有描述性表单元素(input, textarea)添加label, 如<p>姓名:<input type=”text” id=”name” name=”name” /></p>须写成:<p><label for=”name”>姓名: </label><input type=”text” id=”name” /></p>12. 能以背景形式呈现的图片, 尽量写入css样式中;13. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;14. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;15. 特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(&gt;) & 空格( )& ?(?) 等等;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中已建好框架的页面代码<div id=”mainnav”></div>中加入新的div元素,按a命名法则: <div id=”mainnav”><divclass=”firstnav”>…</div></div>,样式写法: #mainnav .firstnav{…….}按b命名法则: <div id=”mainnav”><divclass=”main_firstnav”>…</div></div>,样式写法: .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自身属性及样式继承原理减少代码量, 比如:<ul class=”list”><li>这儿是标题列表<span>2010-09-15</span></ul>定义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. 杜绝使用<meta http-equiv=”X-UA-Compatible” content=”IE=7″ />兼容ie8;14. 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:_background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImage Loader(sizingMetho d=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. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.。

相关文档
最新文档