GVKun编程网logo

WEB 前端开发规范文档(web 前端开发规范文档怎么做)

2

在这里,我们将给大家分享关于WEB前端开发规范文档的知识,让您更了解web前端开发规范文档怎么做的本质,同时也会涉及到如何更有效地.NETWeb部件|Web部件管理器|Web部件区、01.Web基础知

在这里,我们将给大家分享关于WEB 前端开发规范文档的知识,让您更了解web 前端开发规范文档怎么做的本质,同时也会涉及到如何更有效地.NET Web 部件 | Web 部件管理器 | Web 部件区、01.Web 基础知识、第二章 Web 开发基础知识、第五节后端开发基础 --PHP(上)、02.Web 安全基础、第二章常见 Web 漏洞解析、第一节 XSS、02.Web 安全基础、第二章常见 Web 漏洞解析、第四节 URL 跳转的内容。

本文目录一览:

WEB 前端开发规范文档(web 前端开发规范文档怎么做)

WEB 前端开发规范文档(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 rel=”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=”http://itaolun.com/”, 即须在 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”><div class=”firstnav”>…</div></div>,

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

按 b 命名法则: <div id=”mainnav”><div class=”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.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. 减小沉冗代码,书写所有人都可以看的懂的代码。简洁易懂是一种美德。为用户着想,为服务器着想.

.NET Web 部件 | Web 部件管理器 | Web 部件区

.NET Web 部件 | Web 部件管理器 | Web 部件区

如何解决.NET Web 部件 | Web 部件管理器 | Web 部件区

我在 ASP.NET Web 窗体中使用 Web 部件。我的项目运行正常。 但是,当我拖放 Web 部件管理器时出现此错误,谁能指导我如何在 Windows 10 中解决此问题。

与 sql Server 建立连接时发生与网络相关或特定于实例的错误。服务器未找到或无法访问。验证实例名称是否正确以及 sql Server 是否配置为允许远程连接。 (提供程序:sql 网络接口,错误:26 - 错误定位服务器/指定的实例)

01.Web 基础知识、第二章 Web 开发基础知识、第五节后端开发基础 --PHP(上)

01.Web 基础知识、第二章 Web 开发基础知识、第五节后端开发基础 --PHP(上)

目录:

01 PHP 概述

02 PHP 实例

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

02.Web 安全基础、第二章常见 Web 漏洞解析、第一节 XSS

02.Web 安全基础、第二章常见 Web 漏洞解析、第一节 XSS

目录:

01 什么是 XSS

02 XSS 分类

03 XXS 演示

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

存储型 XXS

 

 

反射型 XXS

 

 

DOM 型 XXS

 

 

 

 

 

02.Web 安全基础、第二章常见 Web 漏洞解析、第四节 URL 跳转

02.Web 安全基础、第二章常见 Web 漏洞解析、第四节 URL 跳转

高春辉、王春生、朱峰:关于开源创业的 15 件小事

目录:

01 实例讲解

02 原理分析

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

今天关于WEB 前端开发规范文档web 前端开发规范文档怎么做的讲解已经结束,谢谢您的阅读,如果想了解更多关于.NET Web 部件 | Web 部件管理器 | Web 部件区、01.Web 基础知识、第二章 Web 开发基础知识、第五节后端开发基础 --PHP(上)、02.Web 安全基础、第二章常见 Web 漏洞解析、第一节 XSS、02.Web 安全基础、第二章常见 Web 漏洞解析、第四节 URL 跳转的相关知识,请在本站搜索。

本文标签: