注释或不注释

Question

我正在考虑注释我的域对象。这将减轻DO的操纵。保持域代码免于其他外部事物对我来说也很重要。

通过添加注释来评论域代码的“腐败”？

你是否为域对象添加注解？为什么？

Answer 1

注解（与大多数的东西一样）有折衷。最大的问题是它们是静态的。如果您想在运行时更改注释中表示的属性，那么您运气不好。

当你涉及到涉及的场景时（特别是在处理注释的注释时），他们可能会遇到一些困难。

如果你有很多他们，他们可能会使代码不可读。

然而，在适度，保持简单和正确的情况下，他们确实可以使代码和配置更简单和更清晰。

Answer 2

我认为注释是否使代码更简单是一个好主意，但是，您应该查看已经存在的内容，并且至少使用可能是标注名称的标准。例如，您可以查看JDBC 4.0，Java（http://onjava.com/pub/a/onjava/2006/08/02/jjdbc-4-enhancements-in-java-se-6.html?page=2）或Spring作为示例。

这会做两件事。一个是，如果你决定在某些时候使用这些注释，并摆脱你自己的注释，那么你的代码不会改变。二，它缩短了其他人的学习曲线。

你的注释可能不会进入数据库，但是有很多注释模型在那里，只要确定你是否创建了自己的新名称，你正在做的事情足够独特，否则它就会让那些需要阅读你的代码。

Answer 3

看看Terracotta - 很可能你不必编写自己的注释。我们被提出了类似的困境（我们的DOs不打算用于关系数据库）和兵马俑竟然是一个真正的生活救世主

Answer 4

我们使用注解的具体事情 - 即特殊处理的字符串等 - 和它的作品像一个魅力。注释是处理“元数据”类信息的好方法 - 有关数据对象的数据。我建议查看当前的J2EE注释（我认为它是版本5.0？），因为大多数ORM系统（即Hibernate等）都使用它。

Answer 5

我更喜欢我的注释是描述性的而不是功能性的。例如，JCIP并发注释描述有关类的信息，但不提供其中的功能。导致功能性的注释往往是PFM（纯粹的魔法），使代码更难理解。

这不是一个硬性规则，但当注释执行一些功能性配置和配置文件（如XML）处理其他配置时，这是一种痛苦。它导致代码要求你遍布各处并理解事情应该如何工作的多种配置方案。