我浏览过这个论坛，并且用 google 搜索过这个论坛，但我不确定处理同时出现在同一类中的 Javadoc 和注释的最佳方法是什么。
从我从 Sun/Oracle 的文档中可以看到，他们似乎建议（尽管我无法真正找到明确的声明）Javadoc 应该列在注释之上。
看看他们的例子如何以及何时弃用 API http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/deprecation/deprecation.html.
这对于像 @Deprecated 或 @Override 这样简单的东西非常有效。但是如果您使用 JPA 和/或 Hibernate 呢？您的类和方法必然会被大量注释（有时每个类或方法有两个或更多注释）。
我猜 Javadoc 仍然位于注释之上？
我还想知道注释应该如何最好地使用？我见过一些注释“堆叠”在类、成员、方法之上的示例。我见过其他人在同一行列出注释（通常是这里的方法）。
哪个最好？哪个更具可读性？
您是否“记录”了您在 Javadoc 中注释了某些内容的事实？
我正在寻找一组关于此的良好文档和/或您自己关于什么是最具可读性/可维护性的经验。
Javadoc 只是记录类、方法等的地方。注释可以更改给定代码的功能（如 Hibernate 或 Spring 中的注释）。因此，对我来说，注释显然应该更接近代码（因此，在 javadoc 和方法/函数之间）。
但是注释太多了，怎么写呢？这取决于，我更喜欢将它们放在分开的行中，除非有短路并以某种方式连接，否则很少有例外。
我认为在 Javadoc 中明确记录您正在使用注释并不是一个好主意。注释可以有@Documented注释本身，声明它们应该出现在生成的 javadoc 中。除此之外，它是实现细节 - javadoc 应该告诉你方法/对象是为了什么而创建的，而不是你是如何做到的（大多数情况下，至少）。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
