命名风格 - 智学轩城

命名风格

命名风格应简洁明了,便于识别和记忆,例如:

  • 2023-04-01_产品名称_v1.0.md
  • 项目组-任务类型-日期-负责人-版本号.md
  • 地区-产品类别-版本号-功能描述.md
    这就是坑,别信拼音缩写。 别这么干,命名要统一,避免混淆。

那天,我在咖啡店偶遇一位老友,他刚从公司回来,满脸疲惫。他说,最近项目命名真头疼,每个组都想要用最酷的名字,结果会议室里争论不休。我突然想到,前年我参与的那个项目,当时也是类似的情况。我们团队用了三天时间,每人提出五个候选名,然后投票决定,结果还蛮顺利的。时间:2019年9月,地点:市中心的XX咖啡店,具体数字:我们提出了30个名字,最终投票选出了“星河战队”。等等,还有个事,我记得那时候有个同事提议,名字不仅要酷,还要方便记忆和传播。你看,命名风格,其实还是得考虑实际用途。那,你觉得呢?有没有什么好方法,可以让命名过程更高效一些?

命名风格在软件开发中其实很简单。先说最重要的,一个好的命名应该能直接传达出变量的用途或者类的功能。另外一点,遵循一致性原则也非常关键。比如,去年我们团队开发的一个项目,大概3000量级,我们统一采用驼峰命名法,这样代码看起来整齐有序。
我一开始也以为,只要命名规则一致就好,后来发现不对,还得考虑上下文。比如,一个方法名,如果它处理的是用户数据,那么在方法名中加入“User”前缀是个好习惯。还有个细节挺关键的,就是避免使用缩写,除非在行业内有明确的共识。
说实话挺坑的,这个点很多人没注意。比如,用“db”代替“database”,虽然节省了几个字符,但初学者可能就会搞混。所以,我建议在命名时,尽量做到直观易懂,避免使用行业内的俚语或缩写,除非是团队内部已经达成共识的。
等等,还有个事,命名时还要考虑到国际化问题。如果你的应用面向全球用户,那么避免使用可能在不同语言中有歧义的字词是很重要的。总之,命名风格是代码可读性的基石,值得花时间好好琢磨。

上周,我那个朋友在讨论命名风格。2023年,大家都在追求简洁、易记。值得注意的是,命名风格本质上要符合产品定位。一言以蔽之,简洁明了最重要。每个人情况不同,但尽量做到一致性和专业性。我刚才想到另一件事,你看着办算了。