转载自 http://zhibimo.com/read/Ashu/front-end-style-guide/basic/index.html
基本原则
结构、样式、行为分离
尽量确保文档和模板只包含 HTML 结构,样式都放到样式表里,行为都放到脚本里。
缩进
统一两个空格缩进(总之缩进统一即可),不要使用 Tab 或者 Tab、空格混搭。
文件编码
使用不带 BOM 的 UTF-8 编码。
在 HTML中指定编码 ;
无需使用 @charset 指定样式表的编码,它默认为 UTF-8 (参考 @charset);
一律使用小写字母
<!-- Recommended -->
<img src="google.png" alt="Google">
<!-- Not recommended -->
<A HREF="/">Home</A>
color: #e5e5e5;
color: #E5E5E5;
省略外链资源 URL 协议部分
省略外链资源(图片及其它媒体资源)URL 中的 http / https 协议,使 URL 成为相对地址,避免 Mixed Content 问题,减小文件字节数。
其它协议(ftp 等)的 URL 不省略。
<!-- Recommended -->
<script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>
<!-- Not recommended -->
<script src="http://www.google.com/js/gweb/analytics/autotrack.js"></script>
.example {
background: url(//www.google.com/images/example);
}
.example {
background: url(http://www.google.com/images/example);
}
统一注释
通过配置编辑器,可以提供快捷键来输出一致认可的注释模式。
HTML 注释
模块注释
<!-- 文章列表列表模块 -->
<div class="article-list">
...
</div>
区块注释
<!--
@name: Drop Down Menu
@description: Style of top bar drop down menu.
@author: Ashu(Aaaaaashu@gmail.com)
-->
CSS 注释
组件块和子组件块以及声明块之间使用一空行分隔,子组件块之间三空行分隔;
.selector {
padding: 15px;
margin-bottom: 15px;
}
.selector-secondary {
display: block;
}
.selector-three {
display: span;
}
JavaScript 注释
``
##单行注释
##必须独占一行。// 后跟一个空格,缩进与下一行被注释说明的代码一致。
##多行注释
###避免使用 这样的多行注释。有多行注释内容时,使用多个单行注释。
###函数/方法注释
###函数/方法注释必须包含函数说明,有参数和返回值时必须使用注释标识。;
###参数和返回值注释必须包含类型信息和说明;
###当函数是内部函数,外部不可访问时,可以使用 @inner 标识;
```javascript
/**
* 函数描述
*
* @param {string} p1 参数1的说明
* @param {string} p2 参数2的说明,比较长
* 那就换行了.
* @param {number=} p3 参数3的说明(可选)
* @return {Object} 返回值描述
*/
function foo(p1, p2, p3) {
var p3 = p3 || 10;
return {
p1: p1,
p2: p2,
p3: p3
};
}
<div class="se-preview-section-delimiter"></div>
文件注释
文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西。 应该提供文件的大体内容, 它的作者, 依赖关系和兼容性信息。如下:
/**
* @fileoverview Description of file, its uses and information
* about its dependencies.
* @author user@meizu.com (Firstname Lastname)
* Copyright 2015 Meizu Inc. All Rights Reserved.
*/