维护性的Java注释?

Question

我的项目是缓慢地实现Java注释。一半的开发人员--包括我自己-发现做任何事情复杂的注释似乎加入到我们的整体维护的负担。另一半的团队认为他们是蜜蜂的膝盖。

什么你的真实世界的经验的团队开发人员能够保持附加说明的代码？

Answer 1

我觉得把它分成注释的两种用途 - 注释，以提供一类的“描述”与注释，以提供一个类的“相关性”。

我很好的类“说明”使用注解 - 在这个时候，在类属和注释有助于做出一个速记版本 - JPA注释下这个秋天。

不过，我真的不喜欢的“依赖”的注释 - 如果你直接把依赖的类 - 即使它从一个注释，而不是在类编译时运行时确定的 - 不分手依赖注入？ （也许在精神而不是规则...）

这可能是个人喜好，但我的像的包含我的应用程序的所有依赖信息的一个大的XML文件 - 我认为这是“应用程序配置”而非“类配置”。我通过一个已知的位置，而不是搜索在应用中通过所有的类进行搜索。

Answer 2

我个人的经验是，平均而言，处理与注释是更加容易为最开发商于处理你的标准Java XML配置的地狱。例如访问用户和弹测试他们绝对的生活-储蓄者。

的好事，关于注解的是，他们编配上你的课程的自记录。现在，而不是具有搜索过一个巨大的XML文件，试图找出一个框架如何使用的是你的课，你 类 告诉你。

通常的问题与这样的变化是，获得用来他们只是需要时间。大多数人，包括开发，抵制变革。我记得当我开始的工作的弹簧。在最初的几个星期我想知道为什么有人会把头痛与它相关联。然后，几个星期后，我想知道我怎么会曾经生活离不开它。

Answer 3

我绝对爱注释。我使用它们从休眠/ JPA，Seam中，JAXB ....什么我可以。 IMO有什么比打开一个XML文件，只是找出一类是如何处理的更糟糕。

要我的眼睛注解允许一个类来为自己说话。此外注解（希望）你的IDE内容的一部分帮助，而与XML配置你通常是你自己的。

但是，它可以归结为如何将XML CONFIGS和注释实际使用的任何特定的库（因为大多数同时提供），并且使用什么样的注解。我可以想像，定义的东西是建立特定的注释（例如，文件/ URL路径）实际上可能是作为XML配置更容易。

Answer 4

有高度依赖于IDE支持。我觉得注释应保持同步通过在IDE检查码，但在本该支持有所欠缺。

E.g。如果你不推翻@Override功能IDEA的旧版本会发出警告，但如果你改变了方法签名（或超签名，对于这个问题），并打破了关系，也不会删除@覆盖标签。

如果没有支持我找到他们繁琐的方式添加元数据的代码。

Answer 5

我个人觉得你提到的（自动生成网页形式）的具体使用情况是一个伟大的使用案例的注解。任何形式的“框架”的情况，在那里你可以写简单的代码，并让框架做基于几点建议（又名注释）抬起沉重的（经常重复的），我认为，理想的使用案例的注解。

我很好奇，为什么你的不的像在这种情况下注解，你认为是“维护负担”是什么？ （和，我不是想侮辱你的位置，才明白它）。