前端开发设计规范文档

合集下载

ui规范文档

ui规范文档

ui规范文档UI规范文档。

一、概述。

UI规范文档是为了确保产品设计和开发的一致性和标准化而制定的文档。

它包括了产品的整体设计风格、布局规范、色彩搭配、字体规范、交互设计等内容,旨在为设计师、开发人员和产品经理提供统一的设计标准,以确保产品在不同平台和设备上都能够保持一致的用户体验。

二、设计原则。

1. 一致性,在整个产品中保持一致的设计风格和交互方式,确保用户在不同页面间能够轻松地进行操作和导航。

2. 简洁性,避免过多的视觉元素和复杂的交互设计,保持界面简洁清晰,让用户能够快速找到他们需要的信息。

3. 可用性,设计师应该从用户的角度出发,确保产品的易用性和可理解性,降低用户学习成本和操作难度。

4. 可访问性,考虑到不同用户的需求,包括残障用户,确保产品能够被尽可能多的用户所访问和使用。

5. 反馈性,及时给予用户操作的反馈,让用户清楚地知道他们的操作是否成功或失败。

三、设计规范。

1. 布局规范,页面布局应该简洁清晰,遵循常用的设计布局方式,如F型布局、Z型布局等,保证用户能够快速找到他们需要的信息。

2. 色彩搭配,选择合适的色彩搭配方案,确保色彩的搭配符合产品的整体风格和品牌形象,同时也要考虑到色盲用户的需求。

3. 字体规范,选择合适的字体样式和大小,确保文字的清晰可读,同时也要考虑到不同设备和屏幕的显示效果。

4. 图标规范,选择统一的图标风格和尺寸,确保图标的可识别性和一致性。

5. 交互设计,设计合理的交互方式,包括按钮的设计、导航的设计、页面切换的动画效果等,确保用户能够顺畅地进行操作。

四、开发规范。

1. 前端开发,前端开发人员应该严格按照UI规范文档中的设计规范进行开发,确保页面的布局、色彩、字体、图标等都符合设计师的要求。

2. 后端开发,后端开发人员也应该根据UI规范文档中的设计规范进行开发,确保页面的交互方式和功能的实现都符合设计师的要求。

3. 响应式设计,考虑到不同设备和屏幕的显示效果,开发人员应该确保产品在不同设备上都能够保持良好的显示效果和用户体验。

Web前端开发规范手册

Web前端开发规范手册

Web前端开发规范手册修订历史记录日期版本说明作者2012年12月31日 1.0初稿施昀2012年01月05日 1.1施昀、戴静2012年01月07日 1.2施昀目录修订历史记录 (1)一、规范目的 (2)1.1概述 (2)二、基本准则 (2)三、文件规范 (3)2.1文件命名规则 (3)2.1.1HTML的命名原则 (3)2.1.2图片的命名原则 (3)2.1.3.javascript的命名原则 (4)2.1.4动态语言文件命名原则 (4)2.2文件存放位置规范 (4)2.3CSS书写规范 (4)2.3.1基本原则 (4)2.3.2注意细则 (5)2.3.3命名规则 (6)2.4html书写规范 (9)2.4.1head区代码规范 (9)2.4.2body区代码规范 (10)2.5JavaScript书写规范 (10)2.6图片规范 (10)2.7注释规范 (11)2.7.1html注释 (11)2.7.2css注释 (11)2.7.3JavaScript注释 (11)四、执行模式 (12)一、规范目的1.1概述提高团队协作效率便于前端开发以及后期优化维护方便新进的成员快速上手输出高质量的代码本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发。

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

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

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

开发时需要遵循如上基本准则,特殊情况可以有所宽限,如一些老项目的页面改造。

三、文件规范2.1文件命名规则[使用场景:在新建网页、图片、脚本、CSS文件时,根据此规则给文件命名并放入指定位置]文件名称统一用小写的英文字母、数字和下划线的组合,其中不得包含汉字空格和特殊字符。

命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义,二是当我们在文件夹中使用“按名称排例”的命令时,同一种大类的文件能够排列在一起,以便我们查找、修改、替换、计算负载量等等操作。

前端UI设计规范与标准

前端UI设计规范与标准

前端UI设计规范与标准前言在现代互联网应用的开发中,用户界面(UI)设计在整体用户体验和产品成功中起着至关重要的作用。

良好的前端UI设计可以提升用户的使用体验,并为用户提供高效、直观的界面。

本文将介绍一些前端UI设计的规范和标准,以指导开发人员进行界面设计。

一、色彩选择色彩在UI设计中扮演着重要角色,可以传递品牌形象、情感和风格。

在选择色彩时,应遵循以下规范和标准:1.1 主色调选择根据品牌形象和用户需求,选择主色调。

主色调应与品牌形象相符合,并能够传递出正确的情感和风格。

1.2 色彩搭配选择主色调后,搭配辅助色彩以提升界面的视觉效果。

辅助色彩的选择应考虑到色彩的对比度和相容性,以确保用户界面的可读性和一致性。

1.3 颜色应用在设计界面时,将主色调和辅助色彩合理地应用于各个元素中,如背景色、文本颜色、按钮颜色等。

颜色的应用要一致性,具有明确的层次和视觉重点。

二、布局与结构良好的布局和结构可以使界面更加清晰、易于理解。

以下是一些布局与结构的规范和标准:2.1 界面结构界面应具有清晰的结构与层次,使用户能够轻松理解和操作界面。

采用一致的导航和布局结构,以及明确的标题和标签,能够提高用户界面的可用性。

2.2 响应式设计考虑到不同设备和屏幕大小,采用响应式设计来适应不同的屏幕分辨率。

界面的排版和布局应能够自动调整,并保持良好的可读性和用户体验。

2.3 对齐与间距保持元素之间的对齐和间距的一致性,可以使界面看起来更加整齐和专业。

合理的对齐和间距可以帮助用户理解和扫描界面上的信息。

三、字体与排版在UI设计中,字体的选择和排版的合理运用是非常关键的。

以下是一些字体与排版的规范和标准:3.1 字体选择选择与品牌风格相符合且易于阅读的字体。

字体的大小和粗细应根据不同元素和层次进行调整,以确保良好的可读性。

3.2 字体排版合理运用字体的大小、颜色、对齐和间距,使界面上的文字内容具有良好的视觉效果和阅读体验。

标题、正文和标签的字体排版应有清晰的层次和区分度。

前端UI设计规范完整整理研究

前端UI设计规范完整整理研究

前端UI设计规范完整整理研究一、协议关键信息1、设计原则一致性原则简洁性原则可用性原则可访问性原则响应式设计原则2、颜色规范主色调辅助色调文本颜色背景颜色3、字体规范主字体字体大小字体样式(加粗、倾斜等)行高4、图标规范图标尺寸图标风格图标颜色5、布局规范页面宽度页面间距模块间距对齐方式6、按钮规范按钮形状按钮颜色按钮尺寸按钮文字7、表单规范输入框样式下拉框样式复选框和单选框样式提示信息8、导航栏规范导航栏样式导航栏链接颜色导航栏下拉菜单样式9、图片规范图片格式图片分辨率图片加载方式二、设计原则11 一致性原则在整个前端 UI 设计中,保持视觉、交互和功能的一致性是至关重要的。

这包括颜色、字体、图标、按钮、布局等元素在不同页面和模块中的统一呈现,使用户能够在熟悉的环境中轻松操作和理解界面。

111 简洁性原则避免过度设计和复杂的元素堆砌,以简洁明了的方式展示信息和功能。

简洁的设计能够提高用户的注意力和操作效率,减少认知负担。

112 可用性原则确保设计的界面易于使用和操作,符合用户的习惯和期望。

注重功能的可发现性和易用性,让用户能够快速完成目标任务。

113 可访问性原则考虑到不同用户的需求,包括残疾用户和使用辅助技术的用户,使界面具有良好的可访问性。

遵循相关的可访问性标准,如提供适当的替代文本、键盘导航支持等。

114 响应式设计原则设计应适应不同的屏幕尺寸和设备类型,确保在桌面、平板和手机等设备上都能提供良好的用户体验。

三、颜色规范21 主色调确定一到两种主色调,作为品牌或产品的主要视觉标识。

主色调应具有较高的辨识度和独特性,能够传达出品牌的个性和情感。

211 辅助色调选择若干辅助色调来丰富界面的色彩层次。

辅助色调应与主色调协调搭配,用于强调、区分不同的元素和状态。

212 文本颜色定义不同场景下文本的颜色,如正文、标题、链接、禁用文本等,确保文本清晰可读,与背景形成良好的对比度。

213 背景颜色确定页面背景、模块背景、弹窗背景等的颜色,营造舒适的视觉氛围,避免对用户造成视觉疲劳。

前端开发设计要求规范文档

前端开发设计要求规范文档

前端开发设计规X目录前端开发设计规X (1)一、HTML使用规X (1)、页面文件命名规X (1)、页面head局部书写规X (1)、HTML元素开发规X (2)、HTML元素书写规X (2)、HTML元素命名规X (3)二、WEB页面开发规X (4)、错误跳转页面的处理 (4)、提示信息的处理 (4)、页面的返回 (4)、提交前数据的判断验证 (5)、删除操作 (5)、页面中java代码的使用 (5)、页面布局规X (6)、前台页面尺寸 (6)、标准网页广告图标规格〔参考〕 (6)、页面字体 (7)、字体颜色 (7)三、javaScript开发规X (7)、javaScript文件命名规X: (7)、javaScript开发规X (7)、javaScript书写规X (7)、javaScript命名规X (8)四、css样式规X (10)、css样式文件命名规X (10)、通用样式文件命名规X: (10)、业务类样式文件命名规X (10)、css样式文件命名须知 (11)、css样式文件存放目录规X (11)、css样式定义规X (11)、css样式内容顶部注释规X (11)、css样式内容注释规X (12)、css样式定义规X (12)、css样式常用id的命名 (13)、css样式常用class的命名 (15)、css样式书写规X (15)、css样式排版规X (15)、css样式书写风格规X (16)、css样式属性定义顺序规X (16)、css样式其他规X (17)、css样式Hack的使用 (18)、字体定义规X (18)、css样式检测 (19)、须知事项 (19)、css样式引用规X (19)、媒体内容命名规X (20)五、项目文件存放规X (20)六、前端开发规如此 (20)一、HTML使用规X1.1、页面文件命名规X命名格式为:项目名缩写_所属功能_所属功能子项_... .jsp/html…,文件命名下划线不能超过三个,命名尽量使用简短的能明确明确文件用途的英文或者英文简写。

前端开发设计规范文档

前端开发设计规范文档

前端开发设计规范文档一、引言二、代码编写规范1.缩进和空格-使用2个空格作为一个缩进层级。

- 在每个关键词或运算符后添加一个空格,如if (condition) {}。

-每行代码的末尾都应该去掉多余的空格。

2.行长限制每行代码应控制在80个字符以内,避免过长的代码行导致代码难以阅读和理解。

3.注释-使用注释来解释代码的意图和逻辑。

-使用单行注释(//)来注释一行代码,使用多行注释(/*...*/)来注释一段代码。

-注释要保持与代码同步,当代码发生修改时,注释也应随之更新。

4.变量和函数命名- 使用驼峰命名法(camelCase)命名变量和函数。

变量和函数名应该清晰明确,能够准确表达其含义。

-避免使用缩写和简写,除非是常见的缩写或简写形式。

5.常量命名-使用全大写字母和下划线的命名方式命名常量。

-常量名要具有描述性,能够清晰表达其含义。

6.字符串引号-使用双引号("")包裹字符串,避免使用单引号('')。

7.条件判断和循环语句-在条件判断和循环语句中使用花括号({})包裹代码块,即使只有一行代码。

8.数据类型转换-使用严格相等运算符(===)进行数据类型和值的比较,避免使用弱相等运算符(==)。

三、组织结构规范1.文件和文件夹命名-文件和文件夹命名应该清晰明确,能够准确表达其内容。

-文件和文件夹的命名应使用小写字母、短划线和数字的组合,避免使用空格和特殊字符。

2.目录结构前端项目应该按照一定的目录结构进行组织,常见的目录结构如下:- src:项目源代码目录。

- assets:用于存放静态资源文件,如图片、字体等。

- styles:存放样式文件。

- scripts:存放脚本文件。

- pages:存放页面组件。

四、性能优化规范1.文件合并和压缩-将多个CSS和JS文件合并为一个文件,并进行压缩。

-使用工具和插件进行自动化合并和压缩操作。

2.图片优化- 使用适当的图像格式,如JPEG、PNG、WebP等,以提高图像加载速度。

前端开发规范文档

前端开发规范文档

前端开发规范文档前端开发是指在网站、网页或移动端应用的开发过程中,负责用户界面的设计和开发的工作。

一个良好的前端开发规范可以提高团队的工作效率、降低错误率,并且方便后期的维护和扩展。

本文将介绍一些常见的前端开发规范。

一、HTML规范2.使用正确的缩进和格式:使用合适的缩进和换行,使HTML代码易于阅读和维护。

4. 使用语义化的类名和id名:类名和id名应该能够准确描述元素的作用和功能,避免使用无意义的名称。

二、CSS规范2. 避免使用!important:尽量避免使用!important来覆盖样式,应优先考虑调整选择器的优先级。

3.使用合适的样式复用方式:避免重复的代码,可以使用类名或父子选择器来复用样式。

4. 使用合适的尺寸单位:根据具体情况选择合适的尺寸单位,如px、em、rem等。

5. 使用CSS预处理器:可以使用Sass、Less或Stylus等CSS预处理器来提高开发效率和代码的可维护性。

三、JavaScript规范1. 使用严格模式:在JavaScript代码的开头使用"use strict"启用严格模式,以减少错误和提高代码质量。

2.使用合适的命名规范:变量、函数和类名应该具有描述性的名称,遵循驼峰命名法或下划线分隔符。

3.避免全局变量污染:尽量避免使用全局变量,可以通过使用模块化的方式来封装代码,或者使用命名空间。

4. 避免使用eval和with:避免使用eval函数和with语句,它们可能会引起安全问题和性能问题。

5.使用合适的循环和控制结构:使用合适的循环和控制结构来提高代码的可读性和性能,避免过多嵌套的层级。

四、代码管理规范1. 使用版本控制工具:使用Git等版本控制工具来管理代码的版本,方便团队协作和代码的追踪和回滚。

2.编写有意义的提交信息:每次提交代码时,应编写有意义的提交信息,描述本次提交的内容和目的。

3.周期性地进行代码审查:定期进行代码审查,发现和修复潜在的问题,提高代码质量和稳定性。

前端UI设计规范完整整理

前端UI设计规范完整整理

前端UI设计规范完整整理在前端开发中,UI设计是至关重要的一环。

一个好的UI设计可以提升用户体验,增加用户的粘性,从而提升产品的价值和竞争力。

然而,由于前端UI设计涉及到多个方面,包括视觉设计、交互设计、响应式设计等,因此需要一套规范来指导开发者进行设计工作。

本文将对前端UI设计的规范进行完整整理,以期帮助开发者更好地进行UI设计工作。

一、颜色设计规范1. 颜色搭配- 颜色搭配应遵循色彩原理,避免出现视觉冲突;- 同一页面中,主色调和辅助色调应协调搭配,形成统一的视觉风格;- 避免使用过于亮眼或过于深沉的颜色,以免影响用户的阅读体验。

2. 色彩应用- 使用主色调来强调页面的核心内容;- 使用辅助色调来区分不同的功能模块;- 使用中性色调来增加页面的整体平衡感。

3. 色彩规范- 在设计中可以使用一个品牌色或者几个品牌色,不宜过多;- 避免使用纯黑或纯白,可以适当调整为浅灰色或浅黑色,以增加页面的柔和感。

二、字体设计规范1. 字体选择- 在前端UI设计中应选择合适的字体,以保证页面的可读性;- 对于标题和重要内容可以选择较为醒目的字体;- 对于正文和辅助内容,应选择易读的字体。

2. 字号规范- 标题的字号应在24px以上,以突出其重要性;- 正文的字号应在14px至16px之间,以保证内容的可读性;- 辅助内容的字号可以根据实际情况适当调整。

3. 行距和字距规范- 行距应保持适当的大小,使得文本易于阅读;- 字距应保持适当的大小,以避免相邻文字过于紧凑影响阅读。

三、布局设计规范1. 页面结构- 页面应具备明确的结构,包括头部、导航栏、内容区域和底部等;- 页面的结构应符合用户的阅读习惯,清晰明了。

2. 响应式设计- 页面应具备良好的响应式设计,以适应不同设备的屏幕大小;- 在不同设备上,页面元素的布局应具备良好的可读性和易用性。

3. 图片和图标- 在布局中合理应用图片和图标,使得页面更加丰富多样;- 图片和图标的大小和比例应适应不同设备的屏幕大小。

前端开发中的界面设计原则和规范

前端开发中的界面设计原则和规范

前端开发中的界面设计原则和规范在当今数字化时代,前端开发越来越受到关注和重视。

一个好的界面设计可以提升用户体验、增强用户黏性,对于提高产品的竞争力和市场份额具有重要的作用。

在前端开发中,有一些界面设计原则和规范可以帮助开发者创造出更好的用户界面。

一、简洁明了一个好的界面设计应该力求简洁明了。

这意味着不要过于复杂,避免信息过载,只保留必要的元素和内容。

界面的布局应该简单清晰,重要的信息应该突出显示,不重要的内容可以适当隐藏或被隐藏。

同时,颜色搭配也要尽量避免过于复杂,让用户能够一眼看清主题和功能。

二、一致性一致性是一个好的界面设计的重要特征。

在整个应用程序中保持一致的风格和布局可以提高用户的学习成本,并使用户更容易理解和使用。

在前端开发中,可以通过使用相同的颜色、字体、图标和界面元素来实现一致性。

此外,操作和界面之间的跳转也应保持一致,让用户可以无缝地进行操作。

三、可用性可用性是一个好的界面设计的核心目标。

一个好的界面设计应该能够提供用户需要的功能,并且能够在用户的期望下正常工作。

在前端开发中,可以通过直观的导航、明确的指示、易于理解的标签和按钮等方式来提高界面的可用性。

此外,尽量减少用户输入和点击的步骤,也是提高可用性的重要方法。

四、响应式设计随着移动设备的普及,响应式设计变得越来越重要。

一个好的界面设计应该能够在不同尺寸的屏幕上自适应,并提供优秀的用户体验。

在前端开发中,可以使用响应式布局和媒体查询来实现不同设备上的界面适配。

同时,还要注意在不同设备上测试和调整界面,以确保在各种情况下都能提供良好的用户体验。

五、访问性访问性是一个好的界面设计的重要方面。

一个好的界面设计应该能够让所有用户都能够无障碍地使用和访问。

在前端开发中,可以采取一些措施来提高访问性,比如提供合适的标签、易读的内容、无障碍功能等。

此外,还要确保界面能够在不同的设备和浏览器中正常使用,避免对特定平台的过度依赖。

六、可维护性一个好的界面设计应该具有可维护性。

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。

前端开发中的用户界面设计原则和规范

前端开发中的用户界面设计原则和规范

前端开发中的用户界面设计原则和规范随着互联网的不断发展和普及,前端开发在现代社会中扮演着至关重要的角色。

在构建用户友好的网页应用程序时,用户界面设计是至关重要的一环。

本文将探讨前端开发中的用户界面设计原则和规范,以帮助开发人员提供优秀的用户体验。

一、一致性和可预见性在用户界面设计中,一致性和可预见性是两个核心原则。

一致性意味着在整个应用程序中保持相似的设计模式和交互方式。

通过保持统一的界面风格和统一的元素布局,用户可以更轻松地学习和使用应用程序。

可预见性是指用户可以通过相似的交互方式来预测应用程序的操作和反馈。

例如,在网页表单中,将标签放置在输入字段的前面,并在点击提交按钮后给出适当的反馈信息。

这种一致性和可预见性帮助用户快速熟悉应用程序,并提高用户满意度。

二、简洁和明确的界面在设计用户界面时,简洁和明确的界面是至关重要的。

不要过多地使用不必要的图标、按钮或其他元素。

保持界面简洁,突出重要功能和信息。

使用明确的标签和按钮文本,确保用户能够清楚地理解功能和操作。

同时,提供可见的反馈和指引,以帮助用户理解他们的操作是否成功。

例如,在提交表单后显示一个成功的消息,或者在加载过程中显示一个进度条。

通过简洁和明确的界面,用户可以更容易地理解和使用应用程序。

三、响应式设计和可访问性在今天的多设备时代,响应式设计是不可或缺的。

响应式设计是指根据用户的设备和屏幕大小,自动调整和优化网页布局和功能。

确保你的应用程序能够在不同的设备上提供一致的用户体验,无论是在台式机、移动设备还是平板电脑上。

另外,提供良好的可访问性也是前端开发中的一个重要方面。

确保你的应用程序对视觉、听觉和运动方面有障碍的用户友好。

例如,使用有描述性的文本来代替图像,提供易于导航的键盘快捷键,以及选择合适的颜色和对比度等。

四、合适的交互和反馈提供合适的交互和反馈是提高用户体验的关键。

确保你的应用程序能够及时响应用户的操作,并给出适当的反馈信息。

例如,在用户提交表单后,显示一个缓冲动画或成功消息,以向用户确认他们的操作。

前端UI设计规范制定实施细则

前端UI设计规范制定实施细则

前端UI设计规范制定实施细则随着互联网技术的飞速发展和普及,前端UI设计在网页、App等交互界面中起到了至关重要的作用。

为了确保界面设计的一致性和美观性,许多公司和团队都制定了前端UI设计规范。

本文将详细介绍前端UI设计规范的制定和实施细则,以帮助开发团队更好地进行UI设计工作。

一、规范制定的背景和目的随着前端开发的广泛应用,不同的开发人员可能会根据各自的经验和审美观点进行界面设计,导致界面的风格和设计元素存在差异。

为了解决这个问题,制定前端UI设计规范显得尤为重要。

前端UI设计规范的主要目的是:1. 提高用户体验:通过设计的一致性,用户可以更轻松地理解和操作界面,提高用户的满意度。

2. 提高开发效率:规范的设计可以减少开发人员在设计上的迷茫和纠结,从而节省开发时间和成本。

3. 保持品牌形象:规范的界面设计可以准确传达和展示公司或产品的品牌形象,增强用户对品牌的认知和记忆。

二、规范制定的原则和内容在制定前端UI设计规范时,需要遵循以下原则:1. 一致性原则:界面元素的排版、颜色、按钮样式等要保持一致,以提供更好的用户体验。

2. 技术可行性原则:界面设计要与当前的前端技术相匹配,确保设计的可实现性。

3. 用户友好原则:界面设计要符合用户的使用习惯和心理预期,简洁明了,易于操作。

4. 可扩展性原则:设计规范应该具备可扩展性,以适应未来的功能和需求变化。

前端UI设计规范的具体内容包括但不限于以下几个方面:1. 布局和排版规范:包括网格系统、间距、对齐方式等;文字字号和行距、标题和正文的使用等。

2. 颜色和图标规范:包括主色调、辅助色、图标的颜色和样式等。

3. 图片和多媒体规范:包括图片的尺寸、分辨率限制、格式要求等;多媒体(视频、音频)的使用规范等。

4. 按钮和交互规范:包括按钮的样式、鼠标悬停效果、点击效果等;用户交互的反馈和提示等。

5. 表单和输入规范:包括输入框的设计、表单布局的规范、输入错误提示等。

前端开发设计规范文档

前端开发设计规范文档

前端开发设计规范文档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编码规范、命名规范和注释规范等方面的内容。

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

前端UI设计规范完整整理

前端UI设计规范完整整理

前端UI设计规范完整整理在当今数字化的时代,前端 UI 设计对于用户体验和产品的成功至关重要。

一个清晰、一致且美观的用户界面能够吸引用户,提高用户的满意度和忠诚度。

为了实现这一目标,制定一套完整的前端 UI 设计规范是必不可少的。

本文将对前端 UI 设计规范进行全面的整理,帮助您打造出色的用户界面。

一、颜色颜色是 UI 设计中最具影响力的元素之一。

选择合适的颜色组合能够营造出特定的氛围和情感,同时提高界面的可读性和可识别性。

1、主色调确定一到两种主色调,作为品牌或产品的核心代表色。

这些颜色应该在整个界面中占据主导地位,用于重要元素如按钮、标题等。

2、辅助色选择一些辅助色来补充和协调主色调。

辅助色可以用于次要元素、背景、提示信息等。

3、色彩对比度确保文本与背景之间有足够的对比度,以保证清晰可读。

一般来说,白色背景上的黑色文本或深色背景上的浅色文本是常见的选择。

4、色彩搭配原则遵循色彩搭配的基本原则,如互补色、相邻色、类似色等的搭配方法,以创造出和谐、舒适的视觉效果。

二、字体字体的选择和使用直接影响到用户阅读的舒适度和信息传达的效果。

1、字体家族选择一到两种适合界面风格和用途的字体家族。

常见的字体类型包括无衬线字体(如 Arial、Helvetica)和衬线字体(如 Times New Roman、Georgia)。

2、字体大小设定不同级别的字体大小,用于标题、正文、副标题等。

例如,标题可以使用较大的字号(如 24px 以上),正文可以使用适中的字号(14px 18px)。

3、行高合理设置行高,以保证文本的可读性和排版的美观。

一般来说,行高应该是字体大小的 15 倍到 2 倍。

4、字体颜色根据背景颜色选择合适的字体颜色,确保对比度和清晰度。

5、字体权重使用不同的字体权重(如常规、加粗、斜体)来区分不同的文本重要性。

三、布局良好的布局能够有效地组织和展示信息,提高用户的浏览效率。

1、页面结构确定页面的整体结构,如顶部导航栏、侧边栏、主体内容区域、底部栏等。

Web前端开发规范手册

Web前端开发规范手册

W e b前端开发规范手册内部编号:(YUUT-TBBY-MMUT-URRUY-UOOY-DBUYI-0128)Web前端开发规范手册一、规范目的1.1 概述1二、文件规范2.1文件命名规则 (1)2.2文件存放位置22.3css书写规范32.4html书写规范72.5JavaScript书写规范112.6图片规范122.7注释规范132.8css浏览器兼容13一、规范目的1.1 概述为提高团队协作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,特制订此文档.本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发.本文档如有不对或者不合适的地方请及时提出,经讨论决定后可以更改此文档.二、文件规范2.1文件命名规则文件名称统一用小写的英文字母、数字和下划线的组合,其中不得包含汉字、空格和特殊字符;命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义,二是当我们在文件夹中使用“按名称排例”的命令时,同一种大类的文件能够排列在一起,以便我们查找、修改、替换、计算负载量等等操作。

a.HTML的命名原则引文件统一使用index.htmindex.htmlindex.asp文件名(小写)各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。

例如:关于我们\aboutus信息反馈\feedback产品\product如果栏目名称多而复杂并不好以英文单词命名,则统一使用该栏目名称拼音或拼音的首字母表示;每一个目录中应该包含一个缺省的html文件,文件名统一用index.htmindex.htmlindex.asp;b.图片的命名原则图片的名称分为头尾两部分,用下划线隔开,头部分表示此图片的大类性质例如:广告、标志、菜单、按钮等等。

放置在页面顶部的广告、装饰图案等长方形的图片取名:banner标志性的图片取名为:logo在页面上位置不固定并且带有链接的小图片我们取名为button在页面上某一个位置连续出现,性质相同的链接栏目的图片我们取名:menu 装饰用的照片我们取名:pic不带链接表示标题的图片我们取名:title范例:banner_sohu.gifbanner_sina.gifmenu_aboutus.gifmenu_job.giftitle_news .giflogo_police.giflogo_national.gifpic_people.jpg鼠标感应效果图片命名规范为"图片名+_+on/off"。

前端开发设计规范文档

前端开发设计规范文档

前端开发设计规范文档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. 文件名使用小写字母,并且以连字符(-)连接。

2. 类型命名使用大驼峰命名法,例如:UserInfo。

3. 函数和变量使用小驼峰命名法,例如:getUserInfo。

4. CSS类名使用小写字母,并且以连字符(-)连接,例如:user-info。

二、代码规范1. 使用两个空格缩进代码。

2. 代码段之间加入空行,以提高可读性。

3. 对于较长的代码行,可以使用反斜杠(\)进行分行。

4. 尽量避免使用全局变量,使用局部变量和函数封装来避免变量冲突。

5. 删除不必要的空格、空行和注释。

三、HTML规范1. 缩进使用两个空格。

2. 使用语义化标签,例如:header、nav、section、article、aside等。

3. 尽量避免使用行内样式,使用外部CSS文件来处理样式。

4. 使用双引号来引用属性值。

四、CSS规范1. 使用CSS预处理器,例如:Sass或Less,来提高代码复用性和可维护性。

2. 使用规范的命名方式来命名CSS类名。

3. 使用缩写属性来减少代码量,例如:margin、padding、border等。

4. 使用CSS代码压缩工具来减少文件大小。

五、JavaScript规范1. 使用严格模式,使用"use strict"指令。

2. 避免使用全局变量,使用模块化的方式来封装代码。

3. 使用ES6的新特性来提高代码质量和可读性,例如:箭头函数、解构赋值、模板字符串等。

4. 避免使用eval函数,尽量使用其他方法来解决问题。

5. 使用事件委托方式来处理事件,减少事件监听器的数量。

六、图片规范1. 使用合适的图片格式,例如:JPEG、PNG、GIF等。

2. 压缩图片文件大小,使用压缩工具来减小文件大小。

3. 使用CSS Sprite技术来减少HTTP请求次数。

4. 使用图片懒加载技术来提高页面加载速度。

七、性能规范1. 删除不必要的代码和文件,减少HTTP请求次数。

前端开发设计规范文档

前端开发设计规范文档

前端开发设计规范文档前端开发设计规范文档是一个团队或者组织内部制定的一系列规范和指南,用于规范前端开发的设计、编码和实施流程。

以下是一个包含了1200字以上内容的前端开发设计规范文档:一、命名规范1.使用有意义的和描述性的命名,避免使用简单的缩写和字符组合。

2. 使用驼峰命名法(CamelCase)来命名变量、函数和对象,首字母小写。

3.使用大写字母作为常量和枚举的命名。

4.使用独一无二的名称,避免命名冲突和重复。

5.使用清晰的命名来表示元素的用途和功能,避免歧义和困惑。

6.避免使用中文拼音或其他非英文字符作为命名。

二、代码结构1.使用统一的缩进风格,推荐使用4个空格进行缩进。

2.使用合适的注释来解释代码的功能、用途和实现思路,方便他人理解和维护。

3.使用适当的代码分块和模块化来提高可读性和维护性。

4.使用合适的文件和目录结构来组织代码文件和资源文件。

5.使用版本控制系统来管理代码的变更和追踪。

三、HTML规范4.保持HTML代码的简洁和整洁,避免冗余和重复。

5.使用合适的DOCTYPE声明和字符编码。

四、CSS规范1.使用外部样式表文件来管理CSS代码。

2.避免使用行内样式和内嵌样式。

3.使用语义化的类名来描述样式和选取元素,并避免使用ID选择器。

4.使用合适的选择器进行样式选取,避免不必要的层级和嵌套。

5.使用缩写属性和属性值来减少代码量,提高维护性。

6.使用合适的CSS预处理器来提高开发效率和代码质量。

五、JavaScript规范1.使用语义化的变量和函数名,避免使用全局变量污染全局命名空间。

2. 使用严格模式(strict mode)来提高代码的安全性和性能。

3.使用合适的条件语句和循环语句来控制程序流程。

4. 避免使用eval(和with语句来提高代码的安全性。

5.使用合适的错误处理机制来处理异常和错误。

六、性能优化1.使用合适的压缩工具来减小文件体积和加载时间。

2.使用合适的图片格式和压缩工具来减小图片大小。

前端架构规范范文

前端架构规范范文

前端架构规范范文前端架构规范对于一个项目的可维护性、可扩展性和可重用性都起着至关重要的作用。

一个好的前端架构规范将能够提高开发效率,减少开发成本,并且能够让团队成员更好地协作。

本文将介绍一些常见的前端架构规范和推荐的实践。

1.文件结构规范在一个前端项目中,良好的文件结构能够提高代码的可读性和维护性。

一个常见的文件结构规范如下:- src:存放项目的源代码- pages:存放各个页面的代码- utils:存放一些通用的工具函数- styles:存放项目的样式文件- assets:存放项目的静态资源,如图片、字体文件等- index.js:项目的入口文件- tests:存放测试代码2.命名规范良好的命名规范能够提高代码的可读性和可维护性。

以下是一些常见的命名规范:-变量、函数和组件的命名应具有描述性,能够清晰表达其功能。

-文件和文件夹的命名应使用小写字母和连字符,以提高跨平台的兼容性。

-类名应使用大驼峰命名法,即每个单词的首字母都大写。

3.组件设计规范在前端开发中,组件是代码复用的基本单位。

良好的组件设计规范能够提高代码的可重用性和可维护性。

以下是一些常见的组件设计规范和推荐的实践:-单一职责原则:组件应该只关注一件事情,并且尽量简单。

如果一个组件做太多的事情,将会导致代码难以理解和维护。

-可配置性:组件应该尽量提供可配置的选项,以方便在不同的场景下使用。

-高内聚、低耦合:组件内部的各个部分应该相互关联,形成一个整体。

同时,组件与组件之间应该尽量减少依赖关系,提高代码的可测试性和可重用性。

-组件命名规范:组件的命名应该具有描述性,并且能够清晰表达其功能。

4.状态管理规范在大型前端应用中,管理应用的状态是一个关键问题。

以下是一些常见的状态管理规范和推荐的实践:-单一数据源原则:应用的状态应该集中存储在一个地方,以方便管理和维护。

-状态不可变:状态应该是不可变的,即不允许直接修改状态,而是通过派发动作来修改状态。

前端UI设计规范完整整理

前端UI设计规范完整整理

前端UI设计规范完整整理前言在前端开发中,UI设计是非常重要的一环。

良好的UI设计规范可以提高用户体验,优化用户界面,并且促进团队协作。

本文将对前端UI设计规范进行完整整理,包括颜色选择、字体规范、图标使用、布局规范等方面的内容。

一、颜色选择颜色是UI设计中非常关键的因素之一。

在选择颜色时,我们应该遵循以下几个原则:1. 主色选择:选择一个主色调,用于整体的界面搭建。

主题色应与品牌形象相符,激发用户情感。

2. 辅助色选择:在主色的基础上,选择几个辅助色,用于界面的细节装饰与突出。

辅助色在各个模块中应保持一定的一致性,使整个界面看起来和谐统一。

3. 文字颜色选择:文字颜色应与背景色有足够的对比度,以确保文字能够清晰可读。

4. 禁用色选择:在界面中禁用的元素通常需要有一个特殊的颜色标记,以区别于可操作的元素。

二、字体规范字体是UI设计中传递信息和表达风格的重要手段。

在选择字体时,我们应该遵循以下规范:1. 主要字体选择:选择适合界面风格的主要字体,如 sans-serif、serif、monospace等。

字体应该清晰、易读,并能够在不同的设备上呈现一致的效果。

2. 字号选择:字号应根据不同的元素功能和重要性来调整。

对于标题和重要的文字内容,适当增加字号以突出重点。

3. 行高选择:行高应适中,以保证文字行与行之间的间隔和整体的舒适感。

4. 字间距选择:字间距应适中,以确保文字之间的间距既不会太紧凑也不会太分散。

三、图标使用图标在UI设计中起到了非常重要的作用,它可以帮助用户更快地理解界面的功能和操作方式。

在使用图标时,我们应该遵循以下规范:1. 图标风格选择:选择适合界面风格的图标风格,如扁平化、简约等。

图标的风格应与整体界面保持一致。

2. 图标尺寸选择:根据不同的界面区域和布局,选择合适的图标尺寸。

过大或过小的图标都会影响用户的体验。

3. 图标颜色选择:图标颜色应与整体色调相协调。

对于不同的状态,如活动、禁用、选中等,可使用颜色变化来区分。

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

前端开发设计规范目录一、HTML使用规范、页面文件命名规范命名格式为:项目名缩写_所属功能_所属功能子项_... .jsp/html…,文件命名下划线不能超过三个,命名尽量使用简短的能明确表明文件用途的英文或者英文简写。

、页面head部分书写规范1)、JSP页面:需要在页面的最开始部分增加以下语句:2)、HTML页面:需要在页面的最开始部分增加以下语句:3)、HTML5页面:页面添加编码格式可简写为:4)、响应式的网页添加如下语句:5)、title元素:一般网页必须添加title元素,若为框架页面,则可以不写。

title统一使用中文,title内容要简洁明了,不能超过20个字。

6)、外部js的引用:页面加载时需要用到的js文件写在head中,引用时不用写language属性,HTML5可以省略type属性,如。

7)、外部CSS文件的引用:必须使用link方式引入,HTML5可以省略type属性,CSS文件引入要放在js文件前。

、HTML元素开发规范1)、代码的结构要保持完整性,单个标签必须要关闭,如:<div></div>,<br/>等。

2)、子元素要比父元素缩进两个字符。

3)、body中的所有内容不能直接书写在<body></body>标签中,需要在body中嵌入一层div,所有的元素需要写在改div中。

4)、除非必要,所有标签元素的样式都需要使用CSS文件来定义。

5)、img元素:所有展示用图片都要使用alt属性添加能简要描述图片的文字说明,如首页的广告图片等,必须具有width和height属性。

6)、所有Form都要指定action属性,但属性值需要则填写,不需要则留空,method属性统一使用POST;所有form表单都要在提交前对输入的数据前进行验证,验证使用jQuery validate插件,书写规范如下:7)、所有不可更改的input元素都要设置readonly属性。

8)、按功能模块添加简单明了的注释,在功能模块的开始标明模块开始,结束时标明模块结束,注释单独占一行;模块之间留行间隔便于查看代码。

9)、已过时的元素标签使用CSS样式来代替,已过时的标签属性禁止使用,使用CSS样式定义来实现。

涉及到跟服务端交互的元素,元素命名应当与服务端程序中定义的对应变量名相同,或使用对象名.变量名的形式。

页面上使用到的不涉及与服务端交互的HTML元素其id和name需统一,所有命名使用元素标签的缩写_后缀方式,后缀命名使用小驼峰命名法即第一个单词全部使用小写,其他单词首字母大写,常见元素命名规则如下表所示:二、WEB页面开发规范、错误跳转页面的处理400、401、403、404、405、406、407、410、412、414、500、501、502等错误代码使用其相应的统一页面,所有错误信息全部使用中文错误信息,标点符号使用中文半角符号。

页面设计与项目功能相匹配,做到简洁友好。

、提示信息的处理成功提示信息可以使用弹窗或跳转统一成功页面的方式,成功页面的风格与网站总体风格相同,格式如下:"成功:"+提示信息+"!"。

、页面的返回所有需要返回上一页的时候使用();不使用(-1)。

、提交前数据的判断验证1)、所有由用户输入的数据在提交前都要进行验证。

2)、验证方式使用jQuery validate插件,需要验证的项:长度验证:默认长度为数据库中数据的最大长度,中文占两个字符,英文占一个字符。

为空验证:所有不允许为空的输入内容为空时不允许提交。

其他验证:需要根据输入内容的不同设定合适的验证,如Email格式是否正确,身份证号格式是否正确等。

3)、验证后发现错误,需要提示明确的错误信息。

错误提示信息样式:字体颜色#ff3366,文字前面加红色感叹号小图标。

4)、可输入表单需要具有输入内容的提示信息,可使用placeholder属性来定义或者自定义,颜色必须使用灰色,字体比网站使用字体小。

、删除操作所有涉及删除的操作,需要用户进行确认之后才能进行操作。

、页面中java代码的使用页面中不允许使用<% %>的方式嵌入java代码。

、网站页面布局规范1)、800*600下,网页宽度保持在778以内,就不会出现水平滚动条,高度则视版面和内容决定,1024*768下,网页宽度保持在1002以内,不会出现水平滚动条,高度同样视版面内容决定。

2)、根据第一条原则,规定网页的尺寸为width=960px,height=600px。

3)、页面长度原则上不超过3屏(可根据实际情况设定),宽度不超过1屏。

4)、全尺寸banner为468*60px,半尺寸banner为234*60px,小banner为88*31px。

5)、每个非首页静态页面含图片字节不超过60K,全尺寸banner不超过14K。

1)、120*120,适用于产品或新闻照片展示。

2)、120*60,主要用于做LOGO使用。

3)、120*90,主要应用于产品演示或大型LOGO。

4)、125*125,适于表现照片效果的图像广告。

5)、234*60,适用于框架或左右形式主页的广告链接。

6)、392*72,主要用于有较多图片展示的广告条,用于页眉或页脚。

7)、468*60,应用最为广泛的广告条尺寸,用于页眉或页脚。

8)、88*31,主要用于网页链接,或网站小型LOGO。

正文内容中文统一使用宋体(可根据需要设定),大小为12px,标题使用14px加粗,不建议使用13px字,英文字体使用Arial和Helvetica/Univers。

1)、正文使用灰黑色#333333。

2)、超链接可以使用蓝色#1f376d或#425c9e,也可以根据整体页面布局进行调整,整个网站的文字超链接样式要统一。

三、javaScript开发规范、javaScript文件命名规范:1)、可通用的javaScript文件:项目名称缩写-文件作用.js。

2)、其他javaScript文件:所属功能-文件作用.js。

、javaScript开发规范1)、javaScript代码都需要写在javaScript文件中,在页面中进行调用,调用代码除页面加载时需要用到的外全都写在页面最低端。

2)、如验证用javaScript代码等,每个页面不同且比较短的,可以写在页面的最底端,从最后一个外部javaScript引入命令后开始。

3)、脚本变量开发规范:变量的使用尽量缩小到小的作用域。

如循环使用。

4)、尽量避免使用全局变量。

5)、每一句语句都要以分号“;”结束。

6)、函数程序体缩进四个空格,Tab键为4个空格,以Tab键作为缩进单位。

7)、函数名与“(”之间不应该有空格,“)”与“{”之间加空格。

8)、函数体之间应当加空行。

9)、如果代码本身是清楚的,则只需要在函数定义前,添加简单注释说明该函数的作用,若代码本身比较复杂,可在个别语句后添加简洁明了的注释。

1)、常量以及全局变量名必须全部使用大写字母。

2)、不要再命名中使用“$”和“\”等特殊字符,不要把“_”作为变量名的第一个字符和最后一个字符。

3)、变量名必须使用其类型的缩写字符串开始。

各种类型的缩写字符串如下:4)、变量名必须采用有意义的单词命名,如:strUserName、lngArrayIndex,以及不要出现数字编号命名,如:value1,value2…5)、如果变量名过长可以使用单词缩写,除了被广泛了解的单词缩写以外,所有使用单词缩写的变量名必须在定义时给出注释,如:6)、参数变量命名必须加前缀:p_。

7)、function命名规范:使用动词+名词的方式,并且命名需要明确指出其作用,动词前缀必须是同函数功能相关的完整动词,如getUserId(),用来取用户Id。

8)、所有命名使用小驼峰命名法:第一个单词全部使用小写,其他单词首字母大写,如:myClassName。

四、css样式规范、css样式文件命名规范1)、整个项目通用的css布局样式文件命名为:。

如:通过于整个网站中使用的div、h1、img等的定义文件。

2)、对引用的开源css样式重定义的文件命名为:开源的css样式文件名如:为引用的css样式文件,现在对它的.btn重新定义样式内容,这类样式的文件名命名为:开源的css样式文件名。

一个项目建议最多使用一个css框架。

3)、外部引用的字体css样式文件命名为:font-加引用的字体名字.css,若有多个字体引用则使用:。

4)、自定义的响应式布局样式命名为:项目名称缩写–。

5)、跨项目通用功能定义的css样式文件命名为:实现的功能.css。

6)、为IE浏览器做兼容处理的样式命名为:ie-版本号.css。

自定义的样式统一定义在一个文件内,文件命名为:项目名称。

1)、以上所有的css样式文件命名必须是小写字母,不允许中文、大写字母及其他特殊字符等。

如果有样式版本共存或更新需要保留老版本样式,请在样式文件名后面加上“-版本号”,最新版本样式文件除外,同样版本号只允许是数字或小写字母。

2)、以上css文件命名制定的规范只适用普遍的情况,特殊情况下请开发人员根据实际情况自行命名,但必须遵行1)的规定。

、css样式文件存放目录规范项目文件存放目录将在后面说明,此处只针对css样式文件存放规定。

1)、字体样式文件存放文件夹:/font/,包括字体的源文件。

2)、引用的样式保持原来的目录结构,如果有多个引用的样式则按功能新建文件夹来分别存放。

3)、其他样式文件不用单独新建文件夹。

、css样式定义规范1)、请使用utf-8编码。

2)、申明css定义的内容概述或目的,申明编写的人员、更新日期。

3)、请谨慎使用@import url(……)引入其他css样式文件。

1)、模块注释必须单独写在一行,简要说明模块的功能。

2)、单行注释可以写在单独一行,也可以写在行尾,注释中的每一行长度不超过30个汉字,或者60个英文字符。

3)、多行注释必须写在单独行内,即/*后换行写注释,*/单独写一行。

4)、用于标注修改、待办等信息的注释以单行注释为基准。

5)、对一个代码区块注释(可选),将样式语句分区块并在新行中对其注释。

1)、使用有意义的或通用的id和class命名:id和class的命名应反映该元素的功能或使用通用名称,而不要用抽象的晦涩的命名。

反映元素的使用目的是首选;使用通用名称代表该元素不表特定意义,与其同级元素无异,通常是用于辅助命名;使用功能性或通用的名称可以更适用于文档或模版变化的情况。

2)、id和class命名越简短越好,只要足够表达涵义。

这样既有助于理解,也能提高代码效率。

3)、常用命名(多记多查英文单词):page、wrap、layout、header(head)、footer(foot、ft)、 content(cont)、menu、nav、main、submain、sidebar(side)、logo、banner、 title(tit)、popo(pop)、icon、note、btn、txt、iblock、window(win)、tips等。

相关文档
最新文档