WEB前端规范(一)--HTML规范

保持良好的编程习惯,遵守代码规范,是每一个coder的必修课。至此WEB前端规范(一)就开始了。

文件名

1 所有的文件名都应该遵守相同的命名规范。

2 文件名以小写字母开头,避免数字开头

3 文件名最好全部是小写字母,如果分为几个部分,就以“-”分割开。

4 如果某些部分是作为一个文件的扩展名,则使用“.”进行连接。例:my-validate.min.js  。

不推荐:

MyScript.js
myCamelCaseName.css
i_love_underscores.html
1001-scripts.js
my-file-min.css

推荐:
my-script.js
my-camel-case-name.css
i-love-underscores.html
thousand-and-one-scripts.js
my-file.min.css

链接名

我们一般忽略不写协议(http:  https:)对于图片链接,a标签,或者其他媒体元素。当然如果如果不是这两种协议,需要写上。

不推荐:

.example {
  background: url(http://static.example.com/images/bg.jpg);
}
<script src="http://cdn.com/foundation.min.js"></script>

推荐:

.example {
  background: url(//static.example.com/images/bg.jpg);
}
<script src="//cdn.com/foundation.min.js"></script>

注释:

注释一定要写清楚代码的意图,这样写的原因等等,而不是简单的几个标识,最后自己都不知道是什么意思

不推荐:

var offset = 0;

if(includeLabels) {
  // Add offset of 20
  offset = 20;
}

推荐:

var offset = 0;

if(includeLabels) {
  // If the labels are included we need to have a minimum offset of 20 pixels
  // We need to set it explicitly because of the following bug: http://somebrowservendor.com/issue-tracker/ISSUE-1
  offset = 20;
}

HTML规范正式部分

使用HTML5的文本类型申明.<!DOCTYPE html>

不要将没有内容的标签闭合,如<br>而不是<br />。

使用有效的正确的HTML元素

不推荐:

<title>Test</title>
<article>This is only a test.

推荐:

<!DOCTYPE html>
<meta charset="utf-8">
<title>Test</title>
<article>This is only a test.</article>

脚本加载:

一般将脚本文件放在body的底部,除了一些现代浏览器。

现代浏览器允许:

<html>
  <head>
    <link rel="stylesheet" href="main.css">
    <script src="main.js" async></script>
  </head>
  <body>
    <!-- body goes here -->
  </body>
</html>

所有浏览器:

<html>
  <head>
    <link rel="stylesheet" href="main.css">
  </head>
  <body>
    <!-- body goes here -->

    <script src="main.js" async></script>
  </body>
</html>

提倡使用语义化标签

不推荐:

    

<div class="head">头部</div>
<div class="body">body</div>
<div class="foot">尾部</div>


推荐:

     <header>头部</header>
        <article>正文</article>
        <footer>尾部</footer>

多媒体文件加载失败的补充显示。

不推荐:

<img src="luke-skywalker.jpg">

推荐:

<img src="luke-skywalker.jpg" alt="Luke skywalker riding an alien horse">

不要使用超过两个样式表

不要使用超过两个脚本文件(学会脚本合并)

不要使用内联样式  <style>.no-good {}</style>

不要使用内部样式  <hr style="border-top: 5px solid black">

不使用行内脚本(<script>alert(‘no good‘)</script>

不要让非内容信息污染了你的 HTML,打乱了HTML结构。而是使用before:伪类元素

不推荐:

<!-- We should not introduce an additional element just to solve a design problem  -->
<span class="text-box">
  <span class="square"></span>
  See the square next to me?
</span>
.text-box > .square {
  display: inline-block;
  width: 1rem;
  height: 1rem;
  background-color: red;
}

推荐:

<!-- That‘s clean markup! -->
<span class="text-box">
  See the square next to me?
</span>
// We use a :before pseudo element to solve the design problem of placing a colored square in front of the text content
.text-box:before {
  content: "";
  display: inline-block;
  width: 1rem;
  height: 1rem;
  background-color: red;
}

type属性

不推荐:

<link rel="stylesheet" href="main.css" type="text/css">
<script src="main.js" type="text/javascript"></script>

推荐:

<link rel="stylesheet" href="main.css">
<script src="main.js"></script>

格式化规则

在每一个块状元素,列表元素和表格元素后,加上一新空白行,并对其子孙元素进行缩进。内联元素写在一行内,块状元素还有列表和表格要另起一行。

(如果由于换行的空格引发了不可预计的问题,那将所有元素并入一行也是可以接受的,格式警告总好过错误警告)。

推荐:

<blockquote>
  <p><em>Space</em>, the final frontier.</p>
</blockquote>

<ul>
  <li>Moe</li>
  <li>Larry</li>
  <li>Curly</li>
</ul>

<table>
  <thead>
    <tr>
      <th scope="col">Income</th>
      <th scope="col">Taxes</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>$ 5.00</td>
      <td>$ 4.50</td>
    </tr>
  </tbody>
</table>

使用双引号

不推荐:

<div class=‘news-article‘></div>

推荐:

<div class="news-article"></div>

至此HTML部分的规范已经写完了,当然不同公司有不同的规范,具体情况具体分析。

原文地址:https://github.com/gionkunz/chartist-js/blob/develop/CODINGSTYLE.md

NEC规范:http://nec.netease.com/standard

 
时间: 2024-10-21 08:04:44

WEB前端规范(一)--HTML规范的相关文章

web前端,移动开发规范概述

以下规范建议,均是Alloyteam在日常开发过程中总结提炼出的经验,规范具备较好的项目实践,强烈推荐使用 字体设置 使用无衬线字体 body { font-family: "Helvetica Neue", Helvetica, STHeiTi, sans-serif; } iOS 4.0+ 使用英文字体 Helvetica Neue,之前的iOS版本降级使用 Helvetica.中文字体设置为华文黑体STHeiTi. 需补充说明,华文黑体并不存在iOS的字体库中(http://su

Web前端——Head区域代码规范

Head区域代码规范 1   必须加入的标签 1.1   关键字 <meta name="keywords" content="xxxx,xxxx,xxx,xxxxx,xxxx,"> 1.2   css <link href="../css/style.css" rel="stylesheet" type="text/css"> 1.3   网页显示字符集 简体中文 <meta

web前端开发规范

本文原创,这里首先声明,转载注明本文出处,翻版必究! web前端开发规范的现实意义 1.提高团队的协作能力 2.提高代码的重复利用率 3.可以写出质量更高,效率更好的代码 4.为后期维护提供更好的支持 5.可读性高 一.命名规则 1.html命名规则: a.文件名称命名规则:统一使用小写英文字母.数字.下划线的组合,不得包含汉字空格和特殊字符 2.命名原则:方便理解.方便查找 b.索引文件命名原则:index.html.index.htm.index.asp.index.aspx.index.j

Web前端开发规范文档(google规范)

(Xee:其实没什么规范约束,但是养成一种好习惯,何乐而不为?) 我推荐去看看google的开发规范,然后从他的当中去总结自己的开发规范. Google HTML/CSS代码风格指南 Google JavaScript 编码规范指南 ------------------------------------------------------------------------------------------------------------------------------- 绝大多数项

麦子新课上线之web前端开发规范

同学们,Web前端开发又有课程上线啦!对Web前端感兴趣的同学们,速来围观哦~~下面简单介绍一下课程. [学霸学新,课快人一步] 课程简介: Web前端开发规范,可以帮助同学们,了解web前端开发规范的意义,掌握前端开发中的开发规范,掌握web前端开发中的实用技巧.面对企业团队开发,可以很快融入团队合作中,高效率的完成团队给予的任务. 课程地址→http://www.maiziedu.com/course/web/621-8960/ 老师简介: 何虎:8年软件开发经验,擅长互联网应用程序开发,曾

web项目开发 之 前端规范 --- JavaScript编码规范

JavaScript编码规范 此文严格按照W3C规范和部分实际项目可读性,浏览器加载,性能等众多属性权衡,做出平时前端编码规范文档.供广大web工作者参考并实施,对维护和项目扩展升级都能省时省力. 场景:web前端开发中 一些Javascript的注意事项 和 规格建议: [参考百度资料 和个人一些总结] 1 前言 JavaScript 在百度一直有着广泛的应用,特别是在浏览器端的行为管理.本文档的目标是使 JavaScript 代码风格保持一致,容易被理解和被维护. 虽然本文档是针对 Java

Web前端开发规范收集

在Web开发中,后端跟前端配合非常easy出现故障.这时我们就须要一些规则来约束前端任意的编写. CSS编程规范 1.      属性书写基本顺序 a.      先位置属性(position, top, right, z-index, display, float等) b.      大小(width, height, padding, margin) c.      文字(font, line-height, letter-spacing, color- text-align等) d.   

段焱--web前端开发须知规范

文件规范 1. html, css, js, images文件均归档至<系统开发规范>约定的目录中;2. html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加 功能时查找对应页面;3. css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.;4. Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求

web前端规范

无论是从技术角度还是开发视角,对于web前端开发规范文档都有一定规范,本文就css3和html5的发展前景总结了一系列的web开发文档,仅供大家参考. 规范目的:为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则:符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码