命名约定 - 集合的复数

时间:2012-01-20 09:13:15

标签: naming-conventions

我想对实体集合的命名约定有一些看法。特别是我正在设计一个RESTful URI结构。

如果我有一个实体,例如帐户,我会调用这些实体帐户的集合。同样:客户和客户,订单和订单。通常在实体名称的末尾添加“s”。这是一个适用于命名约定的一致模式。

但是当一些复数词不是简单的标记在最后时,我应该怎么做,例如老鼠和小鼠,人和人甚至鱼和鱼(复数和单数都相同)?

我应该坚持一个简单的模式,只是标记一个与英语惯例不相关的's',或者使用正确的复数形式的单词。

我很想给我的收藏品命名,例如PersonCollection或FishCollection但是虽然它是一致的,但它不是那种我想要输入URI的东西,我希望尽可能简洁。

1 个答案:

答案 0 :(得分:2)

坚持使用英语!当熟悉英语的人可以坐下来使用它时,它使代码或界面的使用更具可读性,可维护性和直观性。在类名,字段名,URI部分......或其他问题中维护包含拼写错误的代码或接口可能会非常令人沮丧,如您提到的使用错误的复数形式。因此,我永远不会使用“Mouses”作为“鼠标”的复数形式。

缩写也可能引起关注。如果它是已知的缩写,请随意使用它。但是,请尝试保持一个严格的命名约定,例如首字母大写为大写,或者全部为大写。尽量避免混合它们。

追加变量或字段的类型就像为它添加前缀。根据所讨论的编程语言,我会遵循一般准则,例如:在Java中我将删除“Collection”-part。就URI而言,我不会使用它。它不会提高可读性。