格式化代码 eclipse_Eclipse代码格式化技巧

格式化代码 eclipse

最近，我在一个大型企业Java项目中被分配了一些代码审查/质量代码修复任务，我正试图协助现有的软件开发团队，同时又要恢复我在另一个项目上的职责。

有点乐趣，但同时又很危险，因为您不想破坏重要的事情或破坏同事的工作，而他们却急于提早发布。 在不了解基础业务的情况下，您必须多次审核，即使您将要做的最小更改也是如此。

有时，编码风格以及它们构造代码的方式对后来进入项目的人们来说非常重要，目的是恢复我们的工作或进行维护工作（就像我目前正在对我不熟悉的代码库所做的那样）真正的大师）。

提示1：编写代码，思考下一个接班人。

我是上述想法的大力支持者。 有时候我们会急着入侵当时看起来很聪明或很棒的代码段，但是在几周内甚至我们都无法理解我们这样做的方式和原因。 尽量保持简单，如果您愿意的话添加内联注释，我非常喜欢阅读代码中的注释，以解释为什么用这种方式而不是另一种方式来开发一段代码。 这些小提示可在下次（很长的将来）节省时间，您将需要检查，修复或更改此部分。

提示2：Eclipse：在某些代码段中禁止自动格式化。

在某些情况下，您必须编写看起来有些复杂的代码，或者想要保存一些行而不是破坏逻辑，尤其是在一些琐碎的部分。 我想出了几个很长的hashCode（）和equals（）方法，它们并不十分复杂，但同时又不明显。 为了完全理解为什么对这些方法执行的检查的某些部分在那里，我不得不以一种格式来手动格式化代码，使得ifs中的逻辑和各种逻辑运算符显而易见。 在其他情况下，诸如FindBugs或CheckStyle之类的工具会警告您有关此类方法内的某些开发决策–大多数情况下都是无效的。

Eclipse通过在代码中添加特殊标记，使您可以自由地部分禁用其格式化程序。 所有您需要做的就是浏览Eclipse Preferences下的以下部分。

首选项– Java –代码样式– 格式化程序–活动配置文件（ 您需要自定义–无法更改内置的Eclipse ）–编辑标签（打开/关闭标签） 启用 。

配置您自己的格式化程序配置文件是一件好事（每个项目甚至更好，或者公司明智）。 您可以继承基本的Eclipse（内置）概要文件并创建自己的概要文件。 启用上述选项后，您就可以排除不想要的代码或您的同事-再次自动格式化，以使其变得难以阅读（丑陋）。

//@formatter:off
    if(aFlag){
    //do this
    }else if(anotherFlag){
     //do that etc
     }
   //@formatter:on

注意：确保团队中的所有成员共享相同的选项，否则，使用默认配置提交其他成员时，会将您的自定义格式设置为以前的状态。

提示3：Eclipse，将花括号放在if语句，循环，equals（）等中。

这是一场持久的战斗，有些开发人员不喜欢花括号，有些人（像我一样）认为他们提高了可读性，而另一些人则不在乎。 我真的很讨厌缺少花括号（我个人的喜好），而且我通常甚至在if语句的简单一行中添加它们。 您可以在这里查看正式的Java 代码约定 。

//@formatter:off
    //I don't like this style
    if(aFlag)
       System.out.println("Do something");
    //I like this style
    if(anotherFlag){
      System.out.println("Do something better");
    }

Eclipse可以帮助您以自动生成的样式或格式修复这种不良的编码样式。 Eclipse Java首选项下有一个“清理”部分，用于在相关代码结构上强制执行“块”。

首选项– Java –代码样式– 清理–活动配置文件（ 您需要自定义–无法更改内置的eclipse ）–编辑选项卡（代码样式–在if / while / for / do语句中使用块）选中“ 始终 ”设置。

注意（再次）：确保团队的所有成员共享相同的选项。

正如我的一位同事指出的那样，有一种特殊情况与Eclipse IDE equals（）方法生成的情况有关。 在eclipse的旧版本中， 实际上存在某种样式错误，但已从3.5版及更高版本修复。

当您从Source中选择-> Generate时具有hashCode（）和equals（）

确保选择“ 在if语句中使用块” 。 这样，您将通过相关工具保存一些代码质量警告。

到此为止，非常感谢GeorgeK和Andreas的关注，技巧和问题。

参考：我们的JCG合作伙伴 Paris Apostolopoulos的Eclipse代码格式化技巧 ，位于Papo的日志中 。

翻译自: https://www.javacodegeeks.com/2012/01/eclipse-code-formatting-tips.html

格式化代码 eclipse