伪命名约定

Question

我们正在做一个大项目在访和加入一些知识共享模块。有些讨论关于命名的项目。

因此，一种可能性时，命名该模块是例如：

cmns-definitions (对 共同的定义)，另一个是 cmns-definition, ，仍然是另一个 cmns-def.这有一些效果，也包装上的名称。现在是 xx.xxx.xxx.xxx.xxx.commons.definitions, 如果改变 cmns-def 它会是 xx.xxx.xxx.xxx.xxx.commons.def.

这个包里面，将类似的枚举和其他定义的可用于整个系统。

我瘦 cmns-definitions 由于没有只有1的定义内包。其他人指出， java.util 没有只有1个用在那里的例子。仍然， java.util 是一个 缩写 对我来说。它可以意味着 java用 或 java公用事业.同样的事情发生 commons-lang.

你会怎么命名？为什么你会选这名字吗？

1. cmns-definitions
2. cmns-definition
3. cmns-def

奖金的问题：如何名称的东西喜欢 cmns-exceptions?这就是我的名字。将你的名字 cmns-xcpt?

ËDIT:

我扔在我自己的想法在这个希望被确认或相矛盾。如果可以的话，请不要。

根据我的想法，背景的理由为什么你的名字的东西是使其更易于理解里面是什么。或者，根据彼得*克林斯让它很容易记住，并能够自动化进程通过的模式。两者都是有效的论点。

我的推理如下条款的模式：

1)当一个substantivation发生，这是众所周知的行业，按照它在您的命名。
例如："特点"的情况。我们有一个模块名为cmns特征。这是不是意味着我们有许多功能在这个模块？没有。它意味着"模块，该模块的实现"功能"的文件从阿帕奇-卡拉夫".
"共享"是一个substantivation的"共同的"公认的行业。这并不意味着"许多共同的".它的意思是"共同的代码"。

如果我看到抽共享作为一个模块名字，我知道，它包含共同的代码抽(在这种情况下萃取)为例。

2)在一定数量的课程模块内部的合作得到一个独特的"一个又一个仅仅"有意义的整体，使用单数形式名称。

大多数模块被包括在这里。如果我的名字的东西cmns-坚持-访问用户的，我的意思是，无论课内部合作，共同提供的访问用户执行情况的cmns-坚持-api。我不指望2的实现，但实际上是一个大类，一起作出一个实施。水晶我清楚。没有？

3)当一个分组类做的唯一目的是收集类的亲和力，但这类不配合在一起不到任何目的，使用复数。

在这种情况为例cmns定义(枚举中使用通过整个系统)。

或者，使用的缩写规避的问题，例如cmns清也可以"解释扩大了"由一人读到cmns-定义。许多人也使用"xxxx-率"的含义xxxx-公用事业。

还有第三种选择可以被用来收拾东西在一起，使用一个名称本身就意味着一个复数形式.单词"api"想到的，但任何单词pluralizes事情会这样做，如"包"。

支持这些情况下(3)众所周知的模块，如公共收藏品(使用复数)，或者公共-可持续发展(中使用的缩写)或公共lang(再次缩写)和任何使用api组类在一起的亲和力。

从apache:
公共-集合->许多强大的数据结构，加速发展的最重要的Java应用程序
公共-lang->机辅助工具的java。lang API
公共-可持续发展->包的几个数据库连接池

Answer 1

它只是一个名字...'

我发现在我漫长的职业生涯，这些只是名称可以做一个巨大的差异在生产力。我不认为这是一个差的，如果你使用 定义, 定义, 或 def 只要你相一致和使用模式的名称，很容易记住，可以用自动化过程。一个建立基于一致的命名方案是无限的工作更容易用于生成有"漂亮的人显示"名称是临时的，并没有明显的模式。

如果您使用的模式，名字往往会变得更短。现在，人们的工作与这些名称通常花费很多时间与他们。所以他们的阅读是几乎不作为重要，因为他们记忆的价值。事实证明，缩写的3个或4个字符的令人惊讶的强大。其中一个原因是他们的工作以及是，只有一个可能的缩写，同时如果你去再有多的候选人。

无论如何，最重要的部分是总体一致性。好运气。

Answer 2

definitions (或 def 或 definition)是一个坏的名字，因为它不具有任何义为一个读者。你在一个面向对象的世界(我)-尽量遵循其公约和原则。模块专家应该叫后最大的"抽象"。"定义"是一种形式，不一意义。

你的问题是类似的："这类名更好 FileUtilities 或 FileUtils".回答：没有。

Answer 3

基本上你做什么用的定义和例外的是提供一种API为您的其他模块。因此我建议将定义，例外和增加接口。然后是有意义的称呼它的所有cmns-api。我通常喜欢单的名称，因为他们是短但是你可以自由决定，因为它只是一个名称。