慢慢整理的Web前端开发规范文档

通用规范

  • TAB键用两个空格代替(WINDOWS下TAB键占四个空格,LINUX下TAB键占八个空格)。
  • CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。
  • 文件内容编码均统一为UTF-8。
  • CSS、JAVASCRIPT中的非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示。

文件规范

  • 多个单词用驼峰命名法
  • 避免拼音命名

文档类型声明

  • <!DOCTYPE html>统一声明为html5类型
  • <meta charset="utf-8">编码统一为UTF-8
  • <meta http-equiv="X-UA-Compatible" content="IE=Edge">通知IE使用最新的内核渲染

css和js文件的引用

    <!DOCTYPE html>
    <html>
    <head>
        <link rel="stylesheet" href="css/main.css">
    </head>
    <body>
        <!-- 逻辑代码 -->
        <!-- 逻辑代码底部 -->
        <script src="lib/jquery/jquery-2.1.1.min.js"></script>
    </body>
    </html>

html属性的排列

  • class
  • id、name
  • data-*
  • src、for、type、href
  • title、alt
  • role
    • CLASS --> nHeadTitle --> CLASS遵循小驼峰命名法(little camel-case)
    • ID --> n_head_title --> ID遵循名称+_
    • NAME --> N_Head_Title --> NAME属性命名遵循首个字母大写+_

表单元素input添加label

    <p>
    <label for="test">测试</label>
    <input type="text" id="test" />
    </p>

HTML中对于属性的定义全部使用双引号

CSS书写顺序。

    .header {
    /* 显示属性 */
        display || visibility
        list-style
        position top || right || bottom || left
        z-index
        clear
        float
    /* 自身属性 */
        width max-width || min-width
        height max-height || min-height
        overflow || clip
        margin
        padding
        outline
        border
        background
    /* 文本属性 */
        color
        font
        text-overflow
        text-align
        text-indent
        line-height
        white-space
        vertical-align
        cursor
        content
        };
  • 兼容多个浏览器时,将标准属性写在底部。
    -moz-border-radius: 15px; /* Firefox */
    -webkit-border-radius: 15px; /* Safari和Chrome */
    border-radius: 15px; /* Opera 10.5+, 以及使用了IE-CSS3的IE浏览器 *//标准属性
  • 多选择器规则之间换行,即当样式针对多个选择器时每个选择器占一行。
    button.btn,
    input.btn,
    input[type="button"] {
    
    };

JavaScript规范

  • 常量名MY_NAME
  • 对象的属性或者方法名
    • 类名 Current
    • 函数名 defaultFun()
    • 变量名 currentValue
    • 私有变量名 _private
  • 下面类型的对象不建议用new构造
    new Number
    new String
    new Boolean
    new Object //用{}代替
    new Array //用[]代替
  • numberstring的转换
    var a = 1;
    var aa = a+'';
  • stringnumber的转换
    var a ='1';
    var aa = parseInt(a,10);
  • floatinteger的转换
    Math.floor(x)//返回一个小于参数x的最大整数,即对浮点数向下取整2.2返回12
    Math.round(x)//对x进行四舍五入,12.2返回12
    Math.ceil(x)//对浮点数进行向上取整,12.2返回13
  • 推荐的拼接方式,避免使用+=
    var str = [];
    for(var i=0; i<3; i++){
        str.push('<div>'+i+'</div>');   
    }
    str.join('');

图片规范

  • 命名使用小写英文,数字,_组合
    • header_btn.png
  • 使用CSS Sprite技术,点我了解更多

注释规范

    /*
    @author 函数/类作者的姓名
    @link 类似于@link标签,用于连接许多其它页面
    @param 用大括号中的参数类型描述一个参数
    @version 函数/类的版本号
    */
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,440评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,814评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,427评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,710评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,625评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,014评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,511评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,162评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,311评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,262评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,278评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,989评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,583评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,664评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,904评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,274评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,856评论 2 339

推荐阅读更多精彩内容

  • 基本准则 符合web标准,html语义化;html,css,JavaScript分离;代码简洁有序,尽可能减少冗余...
    喵呜君阅读 780评论 0 1
  • Web前端开发规范文档 规范目的: 使开发流程更加规范化。 通用规范: TAB键用两个空格代替(WINDOWS下T...
    荞叶阅读 541评论 0 1
  • 一.规范目的 使开发流程更加规范化。 二.通用规范 TAB键用两个空格代替(WINDOWS下TAB键占四个空格,L...
    overflow_hidden阅读 2,415评论 0 0
  • 1:通用规范 tab键用两个空格代替 因为在不同系统的编辑工具对tab解析不一样,windows下的tab键是占四...
    糖心m阅读 444评论 0 1
  • 1、setValue:forKey 中文翻译 :发送setObject:forKey 给接收者,也就是调用setO...
    JC_Wang阅读 466评论 0 1