跳至主要內容

A02.项目词汇与编程命名

trydofor原创规则易读命名大约 1 分钟

A02.项目词汇与编程命名

命名,我认为的程序猿三大头痛问题之一。为此,我励志说把4-8字母的单词都背下来。 但实际情况是,很多业务代码中,命名会造成思路卡顿,要个查字典,看下近义词。

A02A.拼写错误零容忍必须

编辑器中都有拼写检查,一般以波浪线标在下面。当有提示时必须处理。

  • 是拼写错误的立即改正。但公开api中的错误,要兼容性保留。
  • 非拼写的词汇,放到字典中,如elzeclazz

A02B.项目词汇不可污染必须

项目词汇,包括行业词汇,业务字典等,有明确的上下文和业务含义界定。

  • 需要表达业务含义时,不可以使用相近词代替。
  • 不可以把明确的业务词汇,用到非词汇场景的地方。

A02C.前后缀2字母以上必须

在老风格或sql命名中,有单字母前缀表示数据类型的习惯,如i,s等。

  • 单字母前缀,有些lib处理反射时构造setter错误。
  • 单字母后缀,在展示字段时,有些突兀和奇怪。