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

Question

我在实习中一直在使用 Eclipse，在上次测试中，他们给了我一个需要修复的真实项目样本，整个代码一团糟。尽管有人警告我，在日常工作中无法负担完整的代码文档，但从现在开始，我想在我编写的任何代码中努力尝试做到这一点。

需要明确的是，我所说的“文档”是任何方法之前的注释(JavaDoc)，它解释了该方法的作用。当我将鼠标悬停在它上面时可以查看它，就像我使用 String 语句一样。

我知道这些注释位于 Java 源代码的一个类内。

但我认为将 Javadoc 留在文件中会破坏代码的易读性，所以问题是:有没有办法将这些 Javadoc 文档保存在单独的文件中，在我的代码中删除它们，但当我这样做时仍然可见将鼠标悬停在我的方法中？

我已经尝试过“生成 Javadoc”，但由于我在代码中删除了它，因此悬停功能不再起作用。

提前谢谢您。

Answer 1

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

如果注释的长度让您烦恼，像 IntelliJ 这样的 IDE 将允许您折叠 JavaDocs(以及任何其他 block )来隐藏它们:

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

“生成 JavaDoc”是一种解析 JavaDoc 注释并生成可单独浏览或托管在网页上的 HTML 的方法，just like the classes from the JDK have .

<小时/>

顺便说一句，很高兴您有志于编写高质量的文档。世界需要更多这样的开发者。