我看过这个论坛，我用Google搜索了这个，我不确定处理同一类中出现的Javadoc和注释的最佳方法是什么。
从我从Sun / Oracle的文档中可以看到，他们似乎建议（尽管我真的找不到一个明确的陈述）Javadoc应该在注释的顶部列出。
查看他们的示例How and When to Deprecate API's。
对于像@Deprecated或@Override这样简单的东西非常有用。但是，如果你使用JPA和/或Hibernate呢？您的类和方法必须注释得更多（有时每个类或方法有两个或更多注释）。
我猜Javadoc仍然在注释之上？
我也想知道如何最好地使用注释？我已经看到了一些示例，其中注释“堆栈”在类，成员，方法之上。我已经看到其他人在同一行列出注释（通常是这里的方法）。
哪个最好？哪个更具可读性？
你是否“记录”了你在Javadoc中注释某些内容的事实？
我正在寻找一套有关此内容和/或您自己的最易读/可维护体验的文档。
答案 0 :(得分：7)
Javadoc只是您记录类，方法等的地方。注释可以改变给定代码的功能（例如来自Hibernate或Spring的注释）。所以，对我来说，很明显注释应该更接近代码（因此，在javadoc和方法/函数之间）。
但是如何编写注释，其中有很多？这取决于，我更喜欢将它们留在分开的行中，除非有短路且以某种方式连接，否则几乎没有例外。
我认为在Javadoc中明确记录您正在使用注释并不是一个好主意。注释本身可以有@Documented个注释，表明它们应该出现在生成的javadoc中。除此之外，它是实现细节--javadoc应该告诉你是做什么方法/对象，而不是你是如何做到的（至少，大多数情况下）。
答案 1 :(得分：0)
我认为你正在混合代码注释和javadoc注释。
javadoc评论只是：评论。对于您的应用程序而言/** */实际包含的内容并不重要（当然，除非您生成javadoc）
代码注释实际上会影响应用程序的功能。如果省略注释（并且不提供hibernate配置文件），则hibernate映射类将不起作用。仅在javadoc注释中标记为@Deprecated但在代码中不标记的方法将不会被编译器视为已弃用。 （在这种情况下，javadoc工具可能会警告你）
所以是的，代码和javadoc中的注释共享相同的名称，但它们完全不同。如果是@Deprecated，您应该同时使用：在代码中标记它们，并记录原因。