公司的代码规范之html,css

  • 关于普通项目的目录结构,推荐的结构如下:
Project
  -index.html
  pages
    -list.html
    -detail.html
  static
    js
      -app.js
    css
      -app.css
    image
      -bg.jpg
  • 缩进代码(无论哪种代码)使用tab键,开发的时候,设定一个tab键位,是4个空格

  • 过于长的代码,应该做好注释,注释方式如下, 便于修改时候查看结构;各个页面的css如果合并在一处,那么,也要注释,并且能从代码中体现出来,加前缀可以区分,如:

    <!--index start-->
    <div class="index">
        <div>
            <p>一个tab缩进(4个空格)</p>
        </div>
        <img src="" />
        ...
    </div>
    <!--index end-->
/*page_a style .page_a是a.html的最外层容器的class*/
.page_a .box{
    width:100px;
    height:100px;
    background:red;
}
/*page_b style  .page_b是b.html的最外层容器的class*/
.page_b .box{
    width:110px;
    height:100px;
    background:blue;
}
  • 代码应该缩进整齐,开始标签和结束标签对齐,在sublime或者其他编辑器上,可以整齐折叠,便于查看
缩进后的代码
  • 大部分时候,<link>标签置于页面头部,<script>标签置于页面底部

    代码示例

  • 在写手机端页面时候,一定要加<meta name="viewport" content="">标签

  • 在写css的时候,尽量把css抽取出来成为一个单独的文件,不要写在标签和html中

  • 可以多使用语义化的标签,如<section> , <header> , <footer> , <article> 等,对搜索引擎有好处

  • 在定义classid的名字的时候,一定要避免混淆,可读性强.下面是常见的错误的情况,会导致修改一处的样式,其他地方也会受到影响,这种情况要避免,假设有a.htmlb.html,他们都有需要命名一个class为.box他们公用一个样式style.css:

<!--a.html-->
<link rel="stylesheet" type="text/css" href="style.css">
<div class="page_a">
    <div class="box">
        
    </div>
    <img class="thumbnail" src="">
</div>
<!--b.html-->
<link rel="stylesheet" type="text/css" href="style.css">
<div class="page_b">
    <div class="box">
        
    </div>
    <img class="thumbnail" src="">
</div>
/*style.css*/
.box{
    width:100px;
    height:100px;
    background:red;
}

上述的代码,导致a.htmlb.html中的.box都是一个样式,如果这时候客户仅仅想要改变b.html中的.box的样式,一改动.box的话,就会导致a.html中的.box也变化,如果.box的页面使用的多了,就会出现不可控制的结果,所以,推荐的写法是加前缀,style.css改写成:

/*style.css*/

/*page_a style*/
.page_a .box{
    width:100px;
    height:100px;
    background:red;
}
/*page_b style*/
.page_b .box{
    width:110px;
    height:100px;
    background:blue;
}

通过给每个页面的最外层容器加和这个页面相关的class,通过前缀的方式,来区别各个页面上共同的class的样式,对于命名很有帮助.

  • css的库和自己的库结合.经常使用amaze-ui等css框架时候,框架提供了很多的class,比如amaze-ui的按钮类:
<button class="am-btn am-btn-lg am-btn-success">按钮</button>

如果要添加自己的样式,不应该在amaze-ui的css中使用的类,下述是错误的:

.am-btn-lg{
    color:red;
}

这样会导致.am-btn-lg类在这个页面的其他地方异常,正确的方式应该是添加自己的类,然后在写自己的样式:

<button class="am-btn am-btn-lg am-btn-success self-style">按钮</button>
.self-style{
    color:red;
}

原则就是不修改引入的库的任何东西,要改变的话,新添加自己的.

  • 关于命名规则:为了避免和js混淆,自己命名class和id时候,都应该可以改用下划线_,命名应该下上相关,语义化,如:
<div class="page_index">
    <!--页面的容器,box-->
    <div class="box">
        <header>标题</header>
        <!--页面的主要内容 content-->
        <section class="content">
            <!--页面列表-->
            <ul class="list">
                <!--列表项目-->
                <li class="list_item"></li>
                <li class="list_item"></li>
                <li class="list_item"></li>
                <li class="list_item"></li>
            </ul>   
        </section>
    </div>
</div>

这样,仅仅根据class的命名,就可以大概清楚这个标签是什么作用,处于页面什么位置了,非常清晰.

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

推荐阅读更多精彩内容

  • 问答题47 /72 常见浏览器兼容性问题与解决方案? 参考答案 (1)浏览器兼容问题一:不同浏览器的标签默认的外补...
    _Yfling阅读 13,753评论 1 92
  • CSS命名规则 头:header 内容:content/containe 尾:footer 导航:nav 侧栏:s...
    王小傲阅读 1,507评论 0 9
  • 走在路上,我瞥见了 那一双冷漠自傲的眼神 像深涧里潜藏的剑 射出的冷光,让我逃离 可我又分明记起,在暗处 虎王让他...
    止文阅读 157评论 0 2
  • 每天早上的阳光渐渐来的迟了,每当阳光从窗户外撒进来教室里的时候,我感觉仿佛全世界都变得亮堂起来,感觉充满了希望,只...
    艾小咩阅读 247评论 0 0
  • 傍晚,他们在公路旁边的一家小餐馆吃了一顿饭,休息了大概半个小时,在太阳落山之前继续上了路。 “我们要去哪里?”她问...
    零点之前说晚安阅读 302评论 0 0