Web开发规范 (一)

via:Github

通用规范

  • 使用空格代替TAB,windows和Linux的Tab占位不同。
  • CSS样式属性和 JavaScript代码后边添加分号; ,方便断句,利于压缩。
  • 文件内容编码均统一为UTF-8。
  • CSS、JAVASCRIPT中的非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示。

文件规范

  • 文件名用英文单词,多个单词用驼峰命名法。
  • 一些浏览器会将含有这些词的作为广告拦截,文件命名、ID、CLASS等所有命名避免以上词汇。ad`、`ads`、`adv`、`banner`、`sponsor`、`gg`、`guangg`、`guanggao

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=http://kahn1990.com/">//跳转页面,5指时间停留5秒 网页搜索机器人向导。用来告诉搜索机器人哪些页面需要索引,哪些页面不需要索引
 <meta name="robots" content="none">//content的参数有all,none,index,noindex,follow,nofollow,默认是all
 <link rel="Shortcut Icon" href="favicon.ico">//收藏图标
 <meta http-equiv="Cache-Control" content="no-cache, must-revalidate">//网页不会被缓存
  • IE支持通过特定<meta>标签来确定绘制当前页面所应该采用的IE版本。除非有强烈的特殊需求,否则最好是设置为edge mode ,从而通知IE采用其所支持的最新的模式。
meta http-equiv="X-UA-Compatible" content="IE=Edge">
  • 非特殊情况下CSS样式文件外链至HEAD之间,JAVASCRIPT文件外链至页面底部。引入JAVASCRIPT库文件,文件名须包含库名称及版本号及是否为压缩版。引入JAVASCRIPT插件, 文件名格式为库名称+.+插件名称。jQuery.cookie.js

  • HTML属性应当按照以下给出的顺序依次排列,来确保代码的易读性。

class
id 、 name
data-*
src、for、 type、 href
title、alt
aria-*、 role
  • 编码均遵循XHTML标准,标签、属性、属性命名由小写英文、数字和_组成,且所有标签必须闭合,属性值必须用双引号””,避免使用中文拼音尽量简易并要求语义化。
CLASS --> nHeadTitle --> CLASS遵循小驼峰命名法(little camel-case)
ID --> n_head_title --> ID遵循名称+_
NAME --> N_Head_Title --> NAME属性命名遵循首个字母大写+_
<div class="nHeadTitle" id="n_head_title" name="N_Head_Title"></div>
  • 当JAVASCRIPT获取单个元素时,通常使用document.getElementById来获取dom元素,document.getElementById兼容所有浏览器,但IE浏览器会混淆元素的ID和NAME属性,所以要区分ID和NAME命名。
<input type="text" name="test">
<div id="test"></div>
<button onclick="alert(document.getElementById('test').tagName)"></button>
<!-- ie6下为INPUT -->
  • 特殊符号应使用转意符。
<    -->    &lt;
>    -->    &gt;
空格  -->     
  • 含有描述性表单元素(INPUT,TEXTAREA)添加LABEL。
<p>
    <label for="test">测试</label>
    <input type="text" id="test" />
</p>
  • 多用无兼容性问题的HTML内置标签,比如SPAN、EM、STRONG、OPTGROUP、LABEL等,需要自定义HTML标签属性时,首先考虑是否存在已有的合适标签可替换,如果没有,可使用须以“data-”为前缀来添加自定义属性,避免使用其他命名方式。
  • 语义化HTML。
  • 尽可能减少<DIV>嵌套。
  • 书写链接地址时避免重定向。
    href="http://www.kahn1990.com/" //即在URL地址后面加“/”
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,463评论 19 139
  • 原文: https://github.com/ecomfe/spec/blob/master/javascript...
    zock阅读 8,653评论 2 36
  • Web前端开发规范文档 规范目的: 使开发流程更加规范化。 通用规范: TAB键用两个空格代替(WINDOWS下T...
    荞叶阅读 3,508评论 0 1
  • #基本功# 《特质》 当你在听演讲的时候,你最喜欢演讲者身上的什么特质? 看到今天晚上的这个话题,演讲者的特质的时...
    蜜丝姜阅读 1,085评论 0 1
  • 十年前,在洛阳学茶。 大概也是这个样子。每天早早起床,然后穿过车水马龙的大街,到热气腾腾包子铺吃笼包子,这很重要。...
    孔雀堂茶号阅读 3,003评论 0 3