css注释书写规范

“区域注释”、“单行注释”、“注释层级”、“协助注释”四个部分

大部分人使用的区域注释的地方,会以“注释内容开始”或“注释内容结束”,“start”或“end”等,相比之下,以"S"或“E”开始可以更快的使用,比如只要写一次开始或结束的注释,然后复制,改下“S”或“E”就可以快速的完成区域的注释。

区域注释

在实际工作中,有时会出现分不清注释应该在标签之上还是标签之下,为了避免这种情况,注释信息统一写在区域标签开始之前和结束之后,并以“S”或“E”开始,表示区域注释的开始或结束。

html

  <!-- =S 注释内容 -->  
  <div>dddd</div>
  <!-- =E 注释内容 -->

css

  /* =S 注释内容 */  
  .class{
    ....
  }  
  /* =E 注释内容 */
单行注释

注释信息应写在需注释的内容区域里

<div>
  <!-- 注释内容 -->
</div>

/* 注释内容 */
.class{
  ...
}
注释层级

在模块制作中,可能会出现区域中还有区域的情况,为了更好的区分区域之间的层级,引入了蛛丝层级的概念。
区域注释前面的等号表示了当前的注释的层级

html

<!-- =S 注释内容 -->
  ...
  <!-- ==S 注释内容 -->
    ...
      <!-- ===S 注释内容 -->
        ...
      <!-- ===E 注释内容 -->
    ...
  <!-- ==E 注释内容 -->
  ...
<!-- =E 注释内容 -->

css

  /* =S 注释内容 */
    ...
    /* ==S 注释内容 */
      ...
      /* ===S 蛛丝内容 */
        ...
      /* ===E 注释内容 */
      ...
    /* ==E 注释内容 */
    ...
  /* =E 注释内容 */
协助注释

非作者维护时所加入的表示修改时间,修改人等标识信息
在区域注释活单行注释的基础上加上修改人和修改时间等信息。

例如:区域注释
html

<!-- ==S 注释内容[修改人和修改时间] -->
  ...
<!-- ==E 注释内容[修改人和修改时间] -->

css

/*=S 注释内容[修改人和修改时间] */
  ...
/*=E 注释内容[修改人和修改时间] */

例如:单行注释

html

<!--注释内容[修改人和修改时间]-->

css

/* 注释内容[修改人和修改时间] */

另一种参考

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

推荐阅读更多精彩内容

  • 文章整理了Web前端开发中的各种CSS规范,包括文件规范、注释规范、命名规范、书写规范、测试规范等。 一、文件规范...
    二狗子没有夏天阅读 1,840评论 0 35
  • HTML标签解释大全 一、HTML标记 标签:!DOCTYPE 说明:指定了 HTML 文档遵循的文档类型定义(D...
    米塔塔阅读 3,210评论 1 41
  • 作为前端的设计人员,对于CSS的接触,就像吃饭一样。所以CSS命名规范命名是前端人员必看的。文章整理了Web前端开...
    君惜丶阅读 1,966评论 0 8
  • HTML 5 HTML5概述 因特网上的信息是以网页的形式展示给用户的,因此网页是网络信息传递的载体。网页文件是用...
    阿啊阿吖丁阅读 3,803评论 0 0
  • 2018版: 春节回家哪里去? 快来“思考人生”同辈吐槽会 大三研一在读的我 工作多年遭遇瓶颈期的我 相亲数次仍未...
    池浅笑安然阅读 580评论 0 1