先打个广告:欢迎关注我的公众号,参与 文史大挑战 趣味题目。使用方法见 这篇文章 。
![公众号:晚花行乐](/resource/image/blog/wechat-official-account/qr.jpg)
正文开始:
本文是 这篇文章 的翻译,介绍了函数或者类命名时,应该避免和提倡的作法。
Alan Green 批评 xxxManager 命名法是毫无意义:
你是否见过名叫 xxxManager 的类?几乎所有正式商用的系统代码都会有相当多的:SessionManager、ConnectionManager、PolicyManager、QueueManager、UrlManager、ConfigurationManager,甚至是可悲的EJBManager(梗:EJB 是 Java 的企业级组件)
翻翻字典,找一下 “manager” 和 “manage” 的词条,可以得到至少十种不同的意思——从“遵守规定”到“达到目的”。我记得有一天,电话总机接线员直接在电话里自称“总机 manager”。以上这些 manager 的定义似乎都是“看管某样东西”。
由于 Manager 花样繁多的定义,所以在给类起名的时候,它决不是一个好的选择。例如,以一个名为 UrlManager 的类为例,您无法从名称判断它是汇集URL、修改URL还是检查URL的使用。这名字只会告诉你,这个类对URL做了某些事情,具体是什么,不知道。相比之下,UrlBuilder 则对这个类的用途提供了一个更清晰的说明。
在 Java 生态中,以 Manager 结尾的类可多了去了。几乎只要有一个类不管以什么方式向其他对象施加作用,它就会自动被命名 xxxManager。
没有什么比 xxxManager 更有歧义的名字了,请避免使用这个词。Alan 在他的博文中提出了一些替代方案,有助于更详细的说明你的类的实际用途。
给你写的类和对象起一个好点的、描述清晰的名字实属不易。Steve McConnell 在 Code Complete 中文名叫《代码大全》 中提供了一些有用的命名指南:
- 描述整个过程中所做的全部事情
没错,就是全部事情。如果这让名字长得离谱,那不是起名字的问题,是你的程序设计有问题。
- 避免使用无意义、含糊的动词
如 UrlManager、HandleOutput 或 PerformServices。它到底干了些什么事情?如果你不能清楚明白地回答这个问题,那么你需要重构代码了,直到你可以回答这个问题为止。
- 不要通过数字来区分函数
这条只是顺带一提,与题目无关。如果你写出 OutputUser1() 和OutputUser2() 这样的函数,我只能说: 上帝保佑你和你的团队。 意思是以后没人能维护你的代码,包括你自己
- 起名尽可能长
按照 McConnell 的说法,变量名的最佳长度为9到15个字符;函数逻辑相对复杂,可以使用更长的名字,一直长到方便理解的程度。
- 考虑用返回值给函数起名
这是一条简单明了的原则。比如 Printer.IsReady()
,pen.CurrentColor()
等。
- 明确使用反义词
对于 Open()
函数,都应该有一个 Close()
在 ;对于每个 Insert()
都应该有一个 Delete()
配对;Start()
需要一个 Stop()
呼应 。
- 形成惯例,然后遵守
举个例子来说明最合适,McConnell举了一个很好的例子:
employee.id.Get()
dependent.GetId()
supervisor()
candidate.id()
接下来我该怎么获取 id ?
我想说,给类和变量重新起名是我重构代码时最经常做的事。起个好名字的确很难,但也应该很难,因为一个好名字只需一两个词就能表达出函数最根本的意义。
在还没写好一个函数的时候,谁也不知道应该叫它什么名字。除了这个函数以外,代码里其他地方也一样,名称随时会变。给你的变量、对象和函数起个简洁、描述清晰的名称可以让你的代码不再是屎一样的,而是真正想继续写下去的那种。
如果您对本文有疑问或者寻求合作,欢迎 联系邮箱 。邮箱已到剪贴板
精彩评论
本站 是个人网站,采用 署名协议 CC-BY-NC 授权。
欢迎转载,请保留原文链接 https://www.lfhacks.com/tech/i-shall-call-it-something-manager/ ,且不得用于商业用途。