2012-08-14 144 views
181

例如,我有一个名为Purchase Service的RESTful服务。如果我的名字我的仓库git存储库是否有一个命名约定?

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. 或其他什么东西?

什么是约定?在github中如何?公共回购应该遵循一些标准吗?

+3

这篇博客文章可能有些用处http://gravitydept.com/blog/devising-a-git-repository-naming-convention – PHeiberg 2012-08-14 07:31:56

回答

209

我想去purchase-rest-service。理由:

  1. 什么是“pur chase rests ervice”?长而串连的单词很难理解。我知道,我是德国人。 “Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung。”

  2. “_”更难键入比 - 不偏袒任何特定的命名选择

+1

就我个人而言,我更喜欢这个,但显然是基于这里的答案,看起来似乎没有公约......但是。 – 2012-08-14 10:10:01

+78

我没有(真的)明白,但是你是否错过了......在...... auschreibung ......中的S? – Vili 2012-09-03 08:39:31

+0

@Vili:是的。修正:-) – 2012-09-03 09:15:58

17

,请记住,一个git仓库可以克隆到你选择的任何根目录下的“”:

git clone https://github.com/user/repo.git myDir 

这里repo.git将被克隆到myDir目录中。

因此,即使您的公共回购的命名约定最终略有不正确,仍然可以在客户端修复它。

这就是为什么在分布式环境中,任何客户都可以做任何他/她想要的任何事情,Git repo并没有一个真正的命名约定。
(除了储备“xxx.git”为形式回购“xxx”的)
有可能是命名REST服务约定(类似“Are there any naming convention guidelines for REST APIs?”),但这是另外一个问题。

+3

好点。但是,修正客户端的repo名称有点证明命名约定会有帮助。你不觉得吗?为什么修复它,如果它首先遵循了一个惯例?也许maven已经影响了我很多。 – 2012-08-14 09:22:39

+1

@AdrianM我的观点是:是的,命名约定是有用的,但它与Git或GitHub无关,并且与您想要对该特定回购进行的任何操作无关。所以你的问题的答案是“不,git仓库没有命名约定”。 – VonC 2012-08-14 09:37:05

4

也许这只是我的Java和C背景显示,但我更喜欢CamelCase(CapCase)的名称中的标点符号。我的工作组使用这样的名称,可能与存储库包含的应用程序或服务的名称相匹配。

+3

这篇文章很少,并不是我个人的偏好,但他仍然提到一个好处,即Java中的项目名称是骆驼案例,并且在一致性方面有一些安慰。我们是否确定这里的降价不仅仅是一种命名偏见? – eremzeit 2016-09-03 09:01:53

+1

同意。其他答案讨论了camelCase的缺点,但是在Java世界中,决定camelCase更好的方法是完全合理的,尤其是对于那些对Windows世界充满了无知的项目。 – 2017-03-31 14:42:22

28

骆驼案件的问题是,经常会有不同的单词解释 - 例如checkinService和checkInService。与Aaron的回答一起,如果你有许多类似的命名回购,必须经常检查创建回购的人是否使用了大小写的一定分类,那么自动完成很难。避免大写。

他有关破折号的观点也很好。

  1. 使用小写字母。
  2. 使用破折号。
  3. 具体。你可能会发现你必须在以后区分类似的想法 - 例如使用购买休息服务而不是服务或休息服务。
  4. 必须一致。考虑来自各个GIT供应商的使用情况 - 您希望如何对您的存储库进行排序/分组?
+1

您的答案涉及两个重要问题,最重要的答案不是。 – 2015-06-26 14:44:04

19

lowercase-with-hyphens是我的风格最经常在GitHub上看到。*

lowercase_with_underscores可能是第二个最流行的款式我看。

前者是我的首选,因为它可以节省击键。

*轶事;我还没有收集任何数据。

+4

连字符也有搜索引擎优化的优势。这可能不是一个主要考虑因素,但由于我们谈论的是URL,所以它是相关的。 – 2017-03-31 14:39:14

相关问题