2012-01-20 31 views
1

我想獲得關於實體集合的命名約定的一些意見。特別是我設計了一個RESTful URI結構。命名約定 - 集合的複數

如果我有一個實體,例如帳戶,我會召集這些實體帳戶的集合。同樣:客戶和客戶,訂單和訂單。通常在實體名稱的末尾添加's'。對於命名公約來說,這是一個有利的模式。

但是我應該怎麼做,當一些複數的單詞不是簡單的's'結尾標記,例如鼠標和鼠標,人與人甚至魚與魚(複數和單數都一樣)?

我應該堅持一個簡單的模式,只是標記與英語慣例不相干的's',或者以適當的多元化形式去表達。

我一直在試圖命名我的藏品,例如PersonCollection或FishCollection,但雖然一致但很難看,而不是我想要輸入的URI,我希望儘可能簡潔。

回答

2

堅持英語!它讓代碼或者接口的使用更加可讀,可維護,並且直觀,因爲對英語有很好理解的人可以坐下來工作。維護在類名,字段名,URI部分中包含拼寫錯誤的代碼或接口,或者像您提到的那樣使用錯誤的複數形式等其他問題可能會非常令人沮喪。因此,我絕對不會使用「Mouses」作爲「Mouse」的複數形式。

縮寫也可能引起關注。如果它是一個已知的縮寫,請隨時使用它。但是,儘量保持一個嚴格的命名規則,比如第一個字母是大寫,其餘的是小寫,或者全部是大寫。儘量避免混合這些。

追加變量或字段的類型就像是爲它添加前綴。根據所討論的編程語言,我會遵循一般準則,例如在Java中,我會刪除「集合」 - 部分。就URI而言,我不會使用它。它不會提高可讀性。