命名时我们在哪里用词汇表划线?

时间:2009-03-03 16:17:50

标签: language-agnostic

前几天我正在查看我们的代码,并且我遇到了一个类名 IdempotentObject 我当时并不知道这意味着什么,所以我质疑它是否是一个选择不当的名字。我发现是谁编写的,并问开发人员为什么这么混乱地命名它。他很惊讶我不知道这是什么意思,并告诉我这是一个精心挑选的名字,因为该对象是幂等的。

一方面,我看到一个论点,即保持简单,让每个人都能理解一开始就读到的一切。另一方面,我们认为我们应该精确地命名,如果你不知道其含义,请查看它。

哪一个更好,更准确或更容易理解?

7 个答案:

答案 0 :(得分:14)

没有冒犯,但任何拥有CS学位或希望在该领域练习的人都应该认识到“幂等”一词在计算机科学中具有特定含义,即使你不知道该术语并且必须查找它。

另一方面,我不认为对象在名称中应该包含“对象”一词 - 这是多余的。

现在,如果它被称为“IdempotentDataAccessor”或者既精确又具有描述性的东西,那就太好了。

答案 1 :(得分:8)

精确更重要。最初的开发人员或者您可以在之后留下评论来解释命名,如果它不是一个可以在字典中轻松找到或者通常为观众所知的术语。

答案 2 :(得分:5)

“我当时不知道这意味着什么所以我决定这是一个选址不佳的名字。”

有你的问题。如果您不知道什么意思,那么正确的答案就是找出答案。

答案 3 :(得分:4)

我建议将名称限制为问题范围内的名称。幂等对于高级数学应用是可接受的。如果这是一个会计应用程序,我宁愿使用另一个名称。

评论在某些情况下可能会有所帮助,但我更喜欢更改名称。

答案 4 :(得分:3)

作为开发人员,您习惯于查看代码,注意您不熟悉的语言或库的功能,查找并将其合并到您自己对该语言的使用中。

这没什么不同。

你不要强迫别人避开C#的出租人已知功能,你为什么要这样做英语或任何其他语言呢?

查一下,学习它。您是否使用它取决于您,但请不要限制其他用途。你有一个参考。

- 亚当

答案 5 :(得分:2)

我想不出任何其他简洁的方式来描述幂等性。我不认为这是一个问题,因为idempotence是RESTful界面中经常使用的术语,并且在Google搜索中很容易找到清晰的描述。

答案 6 :(得分:1)

嗯,那非常主观。也许对于写这个课程的人来说这个名字很容易理解。很难确定哪些词汇易于理解或难以理解,因为阅读代码的人可能有很多不同的背景。