如何命名

建议学习时长: 30分钟
学习方式:了解

学习目标

  • 不起特别差的名字

详细介绍

There are only two hard things in Computer Science: cache invalidation and naming things.-- Phil Karlton

命名的原则

1 使用名副其实(Intention-Revealing)的名字

  • 不要定义无意义的名字
  • 不要使用magic numbers

2 避免传达错误的意思

  • 避免使用有歧义的名字,比如与其他已存的命名系统相同或相似的名字(比如hp, aix, sco)
  • 避免使用与语言特性相关的词,比如,accountList, 如果它真的是一个某些语言中的List结构还好,如果不是,最好使用bunchOfAccounts或者直接accounts更好。
  • 避免在不同的地方使用只有微妙区别的命名。

3 在命名和命名之间使用有意义的区别

4 使用语音可读的命名

5 使用容易搜索的命名

6 避免发明新的编码方式来命名

7 避免脑补

8 不要使用可爱的命名

9 同一个概念使用同一个单词

10 避免使用双关语

11 使用程序员熟悉的专有名词

12 使用描述问题的命名

13 添加有意义的上下文

14 不要添加无意义的上下文

详细见命名的艺术(clean code阅读笔记之一)

CSS 的常用命名

状态

  • collapsed 收拢的
  • expanded 展开的
  • current 当前
  • selected 选中的
  • active 活跃的
  • enabled 可用
  • disabled 不可用

布局

  • 头部 header
  • 尾部 footer
  • 主栏 main
  • 侧栏 side
  • 盒容器 wrap
  • 条目 item。一般和模块名一起用,如 list-itemnews-item

模块

  • 导航 nav
  • 子导航 subnav
  • 面包屑 crumb
  • 菜单 menu
  • 选项卡 tab
  • 标题 head/title
  • 列表 list
  • 内容 content
  • 表格 table
  • 表单 form
  • 热点 hot
  • 排行 top
  • 登录 login
  • 标志 log
  • 搜索 search
  • 幻灯 slide
  • 提示 tip
  • 帮助 help
  • 新闻 news
  • 下载 download
  • 注册 regist
  • 投票 vote
  • 版权 copyright
  • 结果 result
  • 按钮 button
  • 输入 input
  • 个人中心
    • 用户状态(关注数,喜欢数) user-status
    • 用户头像 avatar
    • 徽章 badge

推荐阅读

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

推荐阅读更多精彩内容