html-1--前端开发规范手册

时间 2019-11-14

标签 html 前端开发规范手册栏目 HTML 繁體版

原文原文链接

HTML布局中经常使用命名规范：javascript

header: 页头　　　　　　　　　　　　　　　　 nav：导航css

footer: 页脚　　　　　　　　　　　　　　　　 column：栏目html

sidebar：侧栏　　　　　　　　　　　　　　　 left:左侧前端

wrapper或wrap：页面外围控制总体布局宽度　　center:中间java

right:右侧　　　　　　　　　　　　　　　　　　logo：标志css3

loginbar：登录条　　　　　　　　　　　　　　main:页面主体web

banner：广告　　　　　　　　　　　　　　　　news：新闻浏览器

hot：热点　　　　　　　　　　　　　　　　　　subnav：子导航缓存

download：下载　　　　　　　　　　　　　　submenu：子菜单服务器

menu：菜单　　　　　　　　　　　　　　　　friendlink：友情连接

search：搜索　　　　　　　　　　　　　　　　scroll：滚动

content/container：内容　　　　　　　　　　msg:提示信息

list: 文章列表　　　　　　　　　　　　　　　　joinus：加入

title：栏目标题　　　　　　　　　　　　　　service:服务

guide：指南　　　　　　　　　　　　　　　　status：状态

vote：投票

1、规范目的

1.1 概述

 提升团队协做效率
 便于前端开发以及后期优化维护
 方便新进的成员快速上手
 输出高质量的代码
本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发。本文档若有
不对或者不合适的地方请及时提出，经讨论决定后能够更新此文档。

规范目的

2、基本准则

  符合 web 标准, 语义化 html, 结构表现行为分离, 兼容性优良。
  代码要求简洁明了有序, 尽量的减少服务器负载, 保证最快的解析速度。
  开发时须要遵循如上基本准则，特殊状况能够有所宽限，如一些老项目的页面改造。

基本准则

3、文件规范

3.1 文件命名规则

[使用场景:在新建网页、图片、脚本、CSS 文件时，根据此规则给文件命名并放入指定位 置]
文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字空格和特殊 字符。命名原则的指导思想：
一是使得你本身和工做组的每个成员可以方便的理解每个文件的意义，
二是当咱们在文件夹中使用“按名称排例”的命令时，同一种大类的文件可以排列在一块儿，以便咱们查找、修改、替换、计算负载量等等操做。

文件命名规范

3.1.1 html命名规范

索引文件统一使用 index.htm index.html index.asp 文件名。 各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如:
若是栏目名称多而复杂并很差以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母 表示。
子页          命名
关于咱们    aboutus
信息反馈    feedback
产品            product
每个目录中应该包含一个缺省的 html 文件，文件名统一用 index.htm index.asp。

HTML 的命名原则

3.1.2 图片的命名规范

图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。 例如:广告、标志、菜单、按钮等等。
 放置在页面顶部的广告、装饰图案等长方形的图片取名: banner
 标志性的图片取名为: logo
index.html
 在页面上位置不固定而且带有连接的小图片咱们取名为 button
 在页面上某一个位置连续出现，性质相同的连接栏目的图片咱们取名: menu
 装饰用的照片咱们取名: pic
 不带连接表示标题的图片咱们取名: title
范 例 : banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg

图片的命名原则

3.1.3 javascript的命名原则

通常使用脚本功能的英文小写缩写命名。
例如:广告条的 javascript 文件名为 ad.js 弹出窗口的 javascript 文件名为 pop.js

javascript的命名原则

3.1.4 动态语言文件命名原则

以性质_描述，描述能够有多个单词，用“_”隔开，性质通常是该页面得概要。
范例:register_form.asp register_post.asp topic_lock.asp

动态语言文件命名原则

3.2 文件存放位置规范

文件存放位置规范
 
文件夹         说明
flash         存放 flash 文件
images        存放图片文件
inc            存放 include 文件
library        存放 DW 库文件
media        存放多媒体文件
script        存放 javascript 脚本
css            存放 css 文件

文件存放位置规范

3.3 CSS 书写规范

[使用场景:书写 CSS 样式时，根据此规则对 id 和 class 进行命名，并遵循书写规则，避免 出现常犯错误，提升效率。]

使用场景

3.3.1 基本原则

CSS 样式可细分为 3 类:从新定义 HTML 样式、连接状态样式、自定义样式。
1. 从新定义 HTML 样式为设计师从新定义已有的 HTML 标签样式，影响所有的被设定标 签样式，用于统一网页中某一标签的样式定义。样式名“HTML 标签”例:hr { border: 1px dotted #333333 }
2. 连接状态样式为设计师对连接不一样状态设定特殊样式，影响被使用本样式区域中的连接。 该样式写法有 2 种: a.nav:link(中间无空格) 、.nav a:link 第一种只能修饰<a>标签中; 第二种能够修饰全部包含有<a>标签的其余标签。
3. 样式为设计师自定义的新 CSS 样式，影响被使用本样式的区域，用于完成网页中局部 的样式设定。样式名 “.”+“相应样式效果描述的单词或缩写”例:“ .shadow ”
文 字 样 式 样 式 名 “ . n o ” + “ 字 号 ” + “ 行 距 ” + “ 颜 色 缩 写 ” 例 :“ . n o 1 2 ” 、“ . n o 1 2 _ 2 4 ” “.no12”类型通常出如今 base.css 文件中，只可选用，不可修改，避免名称含义和实际 内容不符。自定义的样式名最好用意义命名。 好比:重要的新闻高亮显示(像红色)，有两种写法:
red{color:red};
.important_news{color:red}; 很显然第二种传达的意义更加明确,因此尽可能不要用意义不明确的做为自定义命名。
4. 页面内的样式加载必须用连接方式:
<link rel="stylesheet" type="text/css" href="style/style.css">
5. 从新定义的最早，伪类其次，自定义样式最后，便于本身和他人阅读。
6.通常不容许将样式的定义写在标签中(如:style=“color:red;”);
7.全部装饰性的图片(如背景图)，要定义在 CSS 中;

基本原则

3.3.2 注意细则

1. class与id命名: 大的框架命名好比header/footer/wrapper/left/right之类的由设计框 架之人统一命名。其余样式名称由小写英文&数字&_来组合命名, 避免使用中文拼音, 尽可能 使用简易的单词组合; 总之, 命名要语义化, 简明化。
2. 规避class与id重名 , 不建议使用id选择器。
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{.......}
3. 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\ white-space\othertext\content 等
其余属性           list-style(列表样式)\vertical-align\cursor\z-index(层叠顺序) \zoom 等

4. 书写代码前, 考虑并提升样式重复使用率;
5. 杜绝使用<meta http-equiv="X-UA-Compatible" content="IE=7" /> 兼容 ie8;
6. 避免兼容性属性的使用, 好比 text-shadow || css3 的相关属性;
7. 减小使用影响性能的属性, 好比 position:absolute || float ;
8. 重要图片加上 alt 属性;重要的元素和截断的元素加上 title; 
9. 避免使用!important，!important 的优先级最高;
10. 必须为大区块样式添加注释, 小区块适量注释;
11. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化统一处理; 
12. Margin、padding、border、font 等样式尽量采用合并写法;

注意细则

上面的简写图解说明的是依据不一样的属性值能够进行不一样的缩写，这种方法一样适用于 padding 和 Border-width 属性;

Font 的简写对于缩小代码量颇有帮劣，若是没有定义某个属性值的话，将继承父级元素的定义或使用默认值。

3.3.3 命名规则

页面结构
容器: container/wrap	总体宽度:wrapper
页头:header	内容:content
页面主体:main	页尾:footer
侧栏:sidebar	栏目:column
中间内容:center
导航
导航:nav	主导航:mainbav/globalnav
子导航:subnav	顶导航:topnav
边导航:sidebar	左导航:leftsidebar
右导航:rightsidebar	边导航图标:sidebarIcon
菜单:menu	子菜单:submenu
标题: title
功能
标志:logo	登录:login
登陆条:loginbar	注册:regsiter
产品:products	产品价格:products_prices
产品评论:products_review	编辑评论:editor_review
最新产品:news_release	最新产品:news_release
广告/标语:banner	摘要:summary
生产商:publisher	缩略图:screenshot
常见问题:faqs	关键词:keyword
博客:blog	论坛:forum
搜索:search	搜索输入框:search_input
搜索输出:search_output	搜索结果:search_results
加入咱们:joinus	状态:status
按钮:btn	滚动:scroll
标签页:tab	文章列表:list
提示信息:msg/message	当前的:current
小技巧:tips	皮肤:skin
充值:pay	活动:activities
推广:promotion	公告:announcement
排行:ranking	公司简介:company_profile
公司设备:equipment	公司荣誉:glories
企业文化:culture	企业规模:scale
营销网络:sales_network	组织机构:organization
技术力量:technology	分支机构:branches
企业资质:enterprise_qualification	公司实力:strength_strength
经营理念:operation_principle	经理致辞:manager_oration
发展历程:development_history	工程案例:engineering_projects
分类浏览:browse_by_category	应用领域:application_fields
人力资源:human_resource_hr	领致使辞:leader_oration
客户留言:customer_message	客户服务:customer_service
您的要求:your_requirements	销售信息:sales_information
招商:enterprise_establishing	教育培训:education_training
在线交流:online_communication	质量认证:quality_certification
合做加盟:joinIn_cooperation	产品描述:products_description
业务范围:business_scope	产品销售:sales_sales
联系咱们:contact_us	信息发布:information
返回首页:homepage	产品定购:order
电子商务:e_business	版权全部:copy_right
友情连结:hot_link	行业新闻:trade_news
行业动态:trends	邮编:postal_code_zipcode
新闻动态:news_trends	公司名称:company_name
销售热线:sales_hotline	联系人:contact_person
建设中:in_construction	证书:certificate
地址:add	电话:tel
传真:fax	产品名称:product_name
产品说明:description	价格:price
品牌:brand	规格:specification
尺寸:size	生产厂家:manufacuturer
型号:model	产品标号:item_no
技术指标:technique_data	产品描述:description
产地:production_place	用途:application
论坛:forum	在线订购:on_line_order
招标:bidInviting	综述:general
业绩:achievements	大事:great_event
动态:trends	服务:service
投资:investment	行业:industry
规划:programming	环境:environment
发送:delivery	提交:submit
重写:reset	社区:community
业务:business	在线调查:online_inquiry
下载中心:download	意见反馈:feedback
常见问题:faq	中心概况:general_profile
游乐园:amusement_park	专题报道:special_report
图标:icon	注释:note
指南:guild	服务:service
热点:hot	新闻:news
下载:download	投票:vote
商标:label/branding	当前位置:breadcrumb/loc
购物车:shop	标签:tag
信誉:siteinfo_credits	网站信息:siteinfo
法律声明:siteinfo_legal	合做伙伴:partner
友情连接:friendlink	版权:copyright

3.4 html 书写规范

[使用场景:书写 html 页面时，根据此规则对 html 内容进行补充和完善。]

3.4.1 head 区代码规范

head 区是指 HTML 代码的<head>和</head>之间的内容。  必须加入的标签
1. 网页显示字符集
简体中文:
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
繁体中文:
<meta http-equiv ="Content-Type" content ="text/html; charset=utf-8">
英 语:
<meta http-equiv ="Content-Type" content ="text/html; charset=utf-8">
2. 搜索关键字(网站类型)
< meta name="keywords" content ="xxxx,xxxx,xxx,xxxxx,xxxx,">
网页的 css 规范 <link href="../css/style.css" rel="stylesheet" type="text/css">
网页标题 <title>xxxxxxxxxxxxxxxxxx</title>  能够选择加入的标签
1.公司版权注释
<!--- The site is designed by EHM,Inc 07/2005 --->
2. 网页制做者信息
<meta name="author" content="webmaster@maketown.com">
3. 网站简介
<meta name="DESCRIPTION" content ="xxxxxxxxxxxxxxxxxxxxxxxxxx">
4. 设定网页的到期时间。一旦网页过时，必须到服务器上从新调阅。
<meta http-equiv ="expires" content ="Wed, 26 Feb 1997 08:21:57 GMT">
5. 禁止浏览器从本地机的缓存中调阅页面内容。
<meta http-equiv ="Pragma" content ="no-cache">
6. 用来防止别人在框架里调用你的页面。
<meta http-equiv ="Window-target" content ="_top">
7. 自动跳转。
<meta http-equiv ="Refresh" content ="5;url=http://www.yahoo.com">
 5 指时间停留 5 秒
8. 网页搜索机器人向导。用来告诉搜索机器人哪些页面须要索引，哪些页面不须要索引。 <meta name="robots" CONTENT="none">
CONTENT 的参数有 all,none,index,noindex,follow,nofollow。默认是 all。
9. 收藏夹图标 <link rel = "Shortcut Icon" href="favicon.ico"> 
10. 全部的 javascript 的调用尽可能采起外部调用.

head区代码规范

3.4.2 body区代码规范

1. 附<body>标签:
<body>标签不属于 head 区，这里强调一下，为了保证浏览器的兼容性，必须设置页面背 景<body bgcolor="#FFFFFF">(此处为示意，样式需写在 CSS 文件中)
2. 在浏览器里，当咱们点击空连接时，它会自动将当前页面重置到首端，从而影响用户正 常的阅读内容，咱们用代码“javascript:void(null)”代替原来的“#”标记。
<a href="javascript:void(null)">连接</a>

body 区代码规范

3.5 JavaScript 书写规范

[使用场景:书写 js 脚本时，根据此规则对变类、函数、变量命名，并遵循书写规则，避免 出现常犯错误，提升脚本效率。]
1. 书写过程当中, 每行代码结束必须有分号; 原则上全部功能均根据 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, 注重性能.

javascript书写规范

3.6 图片规范

[使用场景:引用添加图片文件时，根据此规则对图片格式进行选择以及命名存放。]
1. 全部页面元素类图片均放入 images 文件夹, 测试用图片放于 images/demoimg 文件 夹;
2. 图片格式仅限于 gif || png || jpg;
3. 命名所有用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符; 尽可能用易懂的词汇, 便于团队其余成员理解; 另, 命名分头尾两部分, 用下划线隔开, 好比ad_left01.gif || btn_submit.gif;
4. 在保证视觉效果的状况下选择最小的图片格式与图片质量, 以减小加载时间; 
5. 尽可能避免使用半透明的 png 图片(若使用, 请参考 css 规范相关说明); 
6. 运用csssprite技术集中小的背景图或图标, 减少页面http请求, 但注意, 请务必在对应
的 sprite psd 源图中划参考线, 并保存至 images 目录下.

图片规范

3.7 注释规范

[使用场景:书写代码时，根据此规则对代码进行适当注释说明，方便本身或他人阅读和理解。]

3.7.1 html 注释

注释格式 <!--这儿是注释-->, '--'只能在注释的始末位置,不可置入注释文字区域。

html注释

3.7.2 css 注释

行间注释:直接写于属性值后面。
例: .search{ border:1pxsolid#fff;/*定义搜索输入框边框*/ background:url(../images/icon.gif)no-report#333;/*定义搜索框的背景*/ } 整段注释:分别在开始及结束地方加入注释。
例:
/*=====搜索条=====*/
.search{ border:1pxsolid#fff;
background:url(../images/icon.gif )no-repeat#333;} /*=====搜索条结束=====*/

css注释

3.7.3 JavaScript 注释

JavaScript 注释, 单行注释使用'//这儿是单行注释' ,多行注释使用 /* 这儿有多行注释 */;

javascript注释

4、执行模式

 规范文档存入部门 SVN 文件库，方便下载查阅。
 根据规范内容，制做网页格式帮助手册。
 根据规则创建和不断完善框架模板库，给不一样类型的网站提供示例参考。  执行规范过程当中根据实际状况不断补充完善规则。
 开发负责人须要检查提交的代码是否符合规范，并记录检查结果。