如何在开发人员之间共享eclipse Java / XML代码样式设置?

时间:2012-12-06 13:53:41

标签: java eclipse coding-style code-standards

在具有许多开发人员的项目中,如果所有IDE都配置了相同的代码样式设置,那么当用户更改代码时,由于更改了格式设置而导致格式控制变为格式控制,因此不会产生伪差异。您可以尝试说服每个人导入项目标准格式设置,但他们可能忘记在创建新工作区时这样做,并且在需要更改时忘记调整它们,因此这会随着时间的推移而丢失。

那么,是否有一种简单的方法可以使每个人都拥有相同的设置并且如果需要更新他们的设置会自动更改 - 他们自己不采取任何行动?

如果这些设置配置为本地项目,则其中许多设置存储在.settings/org.eclipse.jdt.ui.prefs中,因此将此文件签入版本控制但忽略.settings中的其他文件是可行的。不幸的是,格式化程序设置包含在大容器.settings/org.eclipse.jdt.core.prefs中,因此您必须执行更复杂的操作才能更新这些设置。所以我想知道是否有更简单/其他的选择。

澄清:根据我的经验,许多开发人员忽略了在eclipse中调整各种代码样式设置的请求,因为他们认为它们并不重要。所以我想让它们至少非常容易使用项目标准设置,最好是代码风格适应应该完全没有它们的合作 - 特别是在编码风格的更新。我正在寻找工具来做到这一点。

2 个答案:

答案 0 :(得分:1)

警告:在代码风格方面过于严格并不是一个好主意。许多程序员都有自己的风格。所以要小心你想要的。

Eclipse中最简单的方法是创建一个空的工作空间,最初只需将其复制到开发人员的计算机即可。您甚至可以使用所有插件复制Eclipse。这具有必须手动创建更改的缺点。这也是限制性最强的选择。

另一种方法是导出/导入所有设置。这是一项更多的工作,但它的限制性较小。您需要分发以下设置:Formatter,Clean Up,Templates。此外,你仍然需要设置最大值。一般设置中的线条大小。

让人们遵守代码实践的最佳方法是创建有关最低要求的文档。确保记录您的决定并让人们参与。然后检查人们是否遵守它;如果你让它滑倒程序员走自己的路。管理层(不幸的是)可以在这里发挥作用。

强制执行代码样式的最佳方法是创建CheckStyle配置并将其保留为磁盘上的只读文件。然后,您可以将其用作CheckStyle插件的外部样式表。确保Eclipse格式化程序和清理设置匹配。

可以在自动构建环境中使用相同的CheckStyle配置来生成警告和错误。在审核期间应讨论这些警告和错误。确保你有漏洞,如果需要,规则应该被打破。

管理开发人员“与牧羊猫不一样”

答案 1 :(得分:1)

在我的旧公司,我们会创建一个“默认”或“模板”工作区,根据个人喜好配置所有内容(如关键设置,查看位置等)根据公司规则(格式化程序,编译器警告,检查样式​​,强制插件等)。

每次我需要一个新工作区时,我只是复制了这个模板工作区。

由于新的工作场所从头开始是一件很痛苦的事情,人们会自动习惯使用模板,而不是创建一个完整的新工作区。因此,人们忘记这件事从来没有问题。