注释或不注释

时间:2009-09-01 18:14:32

标签: java annotations

我正在考虑注释我的域对象。这将简化对DO的操纵。保持域代码免受其他外部因素的影响对我来说也很重要。

通过添加注释对域代码“损坏”的任何评论?

您是否支持/反对向域对象添加注释,为什么?

5 个答案:

答案 0 :(得分:2)

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

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

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

答案 1 :(得分:1)

注释(像大多数事情一样)都有权衡。最重要的是它们是静态的。如果你想在运行期间更改注释中表示的属性,那你就不走运了。

当您进入相关场景时(特别是当您处理带注释的注释时),它们可能会变得有点困难。

如果你有很多,他们往往会使代码变得不可读。

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

答案 2 :(得分:0)

看看Terracotta - 很可能你不必编写自己的注释。我们遇到了类似的困境(我们的DO不是用于关系数据库)而且Terracotta被证明是一个真实的救世主

答案 3 :(得分:0)

我们对特定事物使用注释 - 即字符串的特殊处理等 - 它就像一个魅力。注释是处理“元数据”类信息的好方法 - 有关数据对象的数据。我建议查看当前的J2EE注释(我认为它是版本5.0?),因为大多数ORM系统(即Hibernate等)使用它。

答案 4 :(得分:0)

我更喜欢我的注释是描述性的而不是功能性的。例如,JCIP并发注释描述了有关类的信息,但不提供其自身的功能。导致功能的注释往往是PFM(纯粹的效果魔法),并使代码更难理解。

这不是一个硬性规则,但是当注释执行某些功能配置和配置文件(如XML)处理其他配置时,这很痛苦。它会导致代码需要您遍布整个地方并了解多种配置方案,以确定其工作方式。