「页面架构」规范与模块化

页面模块化

规范

在具体谈论规范的之前,可以下去查看下各大网络公司的前端开发规范(Developemnt Style Guide)例如谷歌,Facebook 或者 Dropbox。从而更好的理解开发规范在实际应用中和多人协作中的重要性。

不同开发者在开发过程中使用不同的代码风格会直接的提升在之后的开发和维护的成本和难度,对前端开发来说更是尤为突出。这时使用代码规范来约束开发者的编码风格就可以大体解决这些问题。规范的制订应从下面的几个方面来开始考虑:

  • 文件规范
  • 注释规范
  • 命名规范
  • 书写规范
  • 其他规范

文件规范

文件规范又可以从三个方面入手,分类,引入,以及文本本身的内容。

  • 分类(分类可分为通用类业务类。通用类有第三方的库,团队开发的通用模块或者通用样式。业务类则有不同业务所对应的特定模块。)

  • 引入

    • CSS (引入文件则需尽少的使用行内样式)
    • JavaScript (文件名的约束,以及编码设置通常使用 utf-9

注释规范

注释可使用块状,单行注释和行内注释,需要统一缩进等细节要求。

命名规范

例如 CSS 选择器的命名规范

  • 分类命名 (例如 g-header 来给布局类的样式设置命名空间来防止样式污染m-header 来制定模块类的样式)
  • 命名格式 (大小写的规定,建议使用小写并使用 - 分隔,也许控制选择器的长度避免过长的样式选择器名称但不可失去选择器语义)
  • 语义化命名 (以内容的语义来给选择器命名)

书写规范

这里使用 CSS 的书写规范来做示例,可以参考下面的约束:

  • 单行与多行(单行与多行的 CSS 书写格式,使用多行!)
  • 空格与分号(使用空格进行缩进并保留最后一个属性的分号)
  • 书写顺序(更具显示的重要性来安排可参照下表)
  • Hack 方式(三思而后行)
  • 值格式(例如颜色值的格式以及引用中是否使用引号)
module_page_style_order.png

其他规范

这里包括有 HTML 以及图片的规范:

  • HTML
    • 文档声明
    • 闭合
    • 属性
    • 层级
    • 注释
    • 大小写
  • 图片
    • 文件名称(语言以及长度的规范)
    • 保留源文件
    • 图片合并

模块化

模块化是一系列相关的结果组成的整体,这部分具备独立存在的意义不单纯只是表现。

在开发模块化是需要注意的一些步骤(以 CSS 模块化为例):

  • 为模块分类命名(m-module-name
  • 以一个主选择器作为开头(模块跟节点)
  • 使用以主选择器开头的后代选择器(模块子节点)
module_css_class_extend.jpg
module-css-name-module.jpg

模块化可以利于多人开发,便于扩展,当然也可以提高代码的可读性与可维护性。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,391评论 25 707
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,680评论 2 59
  • 第一部分 HTML&CSS整理答案 1. 什么是HTML5? 答:HTML5是最新的HTML标准。 注意:讲述HT...
    kismetajun阅读 27,400评论 1 45
  • 2018一百篇—003 看了前两部《前任》后,本不打算看第三部的。不过最近前任3刷屏了朋友圈微博,还有说一个个...
    Bgwaew阅读 1,067评论 0 0