Eclipse上的单独文件中的Java文档

Question

我在实习期间一直在使用Eclipse，在最后一次测试中，他们给了我一个真正的项目样本来修复，整个代码都是一个怪异的混乱。虽然我已经被警告过在日常工作中无法承受完整的代码文档，但我还是很难尝试用我现在编写的任何代码来完成它。

要明确，＆＃34;文档＆＃34;我说的是在任何方法（JavaDoc）之前的那条评论，它解释了该方法的作用。它可以在我悬停在它上面时查看，就像我使用String语句一样。

我知道这些注释是在Java源代码中的一个类中。

但我认为将Javadoc留在文件中会破坏我的代码的易读性，所以问题是：有没有办法将这些Javadoc文档保存在一个单独的文件中，在我的代码中删除它们，但是当我在悬停在我的方法中？

我已经尝试过生成Javadoc＆＃34;但是因为我在代码中删除了它，所以悬停的东西已经不再适用了。

提前谢谢。

Answer 1

JavaDocs必须是内联的。当你想到它时，它是有道理的。如果您要更改方法的签名或行为，并且该方法的文档在其他文件中已关闭，那么您很快就会得到不准确且因此无用的文档。人们会忘记更新它，或者他们会因为麻烦而故意避免这样做。

如果评论的长度让您烦恼，那么像IntelliJ这样的IDE将允许您折叠JavaDocs（以及任何其他块）来隐藏它们：

自从我使用Eclipse以来已经有一段时间了，但我怀疑它是一样的。

＆＃34;生成JavaDoc＆＃34;是一种解析JavaDoc注释并生成HTML的方法，可以单独浏览或托管在网页just like the classes from the JDK have上。

顺便说一下，你很有兴趣写出高质量的文档。世界需要更多这样的开发者。

Answer 2

不，不可能将Javadoc放到其他地方。 Javadoc背后的整个想法是＆＃34;让我们将文档直接放入源代码＆＃34;。

背后的原因是，对于大多数开发人员而言，这与实际代码相差甚远，因为他们愿意寻找文档，而且他们可能会费心去写一些。