代码规范整理

ゝ一纸荒年。 2022-05-29 01:39 323阅读 0赞

58到家、快狗打车(58速运)、58家政收简历啦~
最近想换工作的同学~ 欢迎拿简历砸我~ 加我微信:15501423004 (记得备注 内推 哈~)

代码规范

希望自己的代码是清晰、可读的。因此给自己指定一定的规范,根据自己实践结果不断改进。
内容中有摘自网络的部分,在文章附录中附有链接,如果侵权联系删除。


命名规则

项目、js、css、HTML文件命名

全部采用小写方式, 以下划线分隔。
例:my_project_name、data_models、account_model.js、retina_sprites.scss、error_report.html

Class命名

常见class关键词

  • 布局类:header, footer, container, main, content, aside, page, section
  • 包裹类:wrap, inner
  • 区块类:region, block, box
  • 结构类:hd, bd, ft, top, bottom, left, right, middle, col, row, grid, span
  • 列表类:list, item, field
  • 主次类:primary, secondary, sub, minor
  • 大小类:s, m, l, xl, large, small
  • 状态类:active, current, checked, hover, fail, success, warn, error, on, off
  • 导航类:nav, prev, next, breadcrumb, forward, back, indicator, paging, first, last
  • 交互类:tips, alert, modal, pop, panel, tabs, accordion, slide, scroll, overlay,
  • 星级类:rate, star
  • 分割类:group, seperate, divider
  • 等分类:full, half, third, quarter
  • 表格类:table, tr, td, cell, row
  • 图片类:img, thumbnail, original, album, gallery
  • 语言类:cn, en
  • 论坛类:forum, bbs, topic, post
  • 方向类:up, down, left, right
  • 其他语义类:btn, close, ok, cancel, switch; link, title, info, intro, more, icon; form, label, search, contact, phone, date, email, user; view, loading…

Css书写顺序

  • 位置属性(position, top, right, z-index,display, float等)
  • 大小(width, height, padding, margin)
  • 文字系列(font, line-height, letter-spacing,color- text-align等)
  • 背景(background, border等)
  • 其他(animation, transition等)

HTML标签属性顺序

属性应该按照特定的顺序出现以保证易读性;

  • class
  • id
  • name
  • data-*
  • src, for, type, href, value , max-length, max, min, pattern
  • placeholder, title, alt
  • aria-*, role
  • required, readonly, disabled

class是为高可复用组件设计的,所以应处在第一位;
id更加具体且应该尽量少使用,所以将它放在第二位。


附录

  1. https://www.zhihu.com/question/19586885
  2. http://alloyteam.github.io/CodeGuide/
  3. https://www.cnblogs.com/allenc/p/5178119.html

发表评论

表情:
评论列表 (有 0 条评论,323人围观)

还没有评论,来说两句吧...

相关阅读

    相关 PHPDocumentor 注释规范整理

     你会写注释么?从我写代码开始,这个问题就一直困扰着我,相信也同样困扰着其他同学。以前的写注释总是没有一套行之有效的标准,给维护和协同开发带了许多麻烦,直到最近读到了phpd

    相关 代码规范整理

    > 58到家、快狗打车(58速运)、58家政收简历啦~ > 最近想换工作的同学~ 欢迎拿简历砸我~ 加我微信:15501423004 (记得备注 内推 哈~) 代码规范

    相关 前端CSS规范整理

    一、文件规范 1、文件均归档至约定的目录中。 具体要求通过豆瓣的CSS规范进行讲解: 所有的CSS分为两大类:通用类和业务类。通用的CSS文件,放在如下目录中: ...