Java Eclipse 上单独文件中的文档
Java documentations in a separate file on Eclipse
我在实习期间一直在使用 Eclipse，在上次测试中，他们给了我一个真实项目的样本来修复，整个代码一团糟。尽管有人警告我在日常工作中无法负担完整的代码文档，但从现在开始，我想在我编写的任何代码中努力做到这一点。
需要说明的是，我所说的 "documentation" 是任何方法之前的那条注释 (JavaDoc)，它解释了该方法的作用。当我将鼠标悬停在它上面时可以查看它，就像我使用 String 语句时一样。
我知道这些注释在 Java 源代码中的 class 中。
但我认为将 Javadoc 留在文件中会破坏我的代码的易读性，所以问题是：有没有办法将这些 Javadoc 文档保存在单独的文件中，在我的代码中删除它们，但当我将鼠标悬停在我的方法中时它们仍然可见？
我已经尝试过 "Generate Javadoc"，但由于我在代码中删除了它，因此悬停功能不再起作用。
提前谢谢你。
JavaDocs 必须是内联的。当您考虑它时，这是有道理的。如果您要更改方法的签名或行为，而该方法的文档在其他文件中丢失，您很快就会得到不准确且无用的文档。人们会忘记更新它，或者他们会因为麻烦而故意避免这样做。
如果评论的长度让您感到厌烦，像 IntelliJ 这样的 IDE 将允许您折叠 JavaDocs（和任何其他块）以隐藏它们：
我已经有一段时间没有使用 Eclipse 了，但我怀疑它是一样的。
"Generate JavaDoc" 是一种解析您的 JavaDoc 注释并生成 HTML 的方法，可以单独浏览或托管在网页上，just like the classes from the JDK have.
顺便说一下，你有志于编写高质量的文档，真是太好了。世界需要更多这样的开发者。
不，不可能将 Javadoc 放在其他地方。 Javadoc 背后的整个思想是 "let's put the documentation directly into source code".
其背后的原因是，对于大多数开发人员来说，这与他们愿意查找文档的实际代码有多远，以及他们是否愿意去写一些。
我在实习期间一直在使用 Eclipse，在上次测试中，他们给了我一个真实项目的样本来修复，整个代码一团糟。尽管有人警告我在日常工作中无法负担完整的代码文档，但从现在开始，我想在我编写的任何代码中努力做到这一点。
需要说明的是，我所说的 "documentation" 是任何方法之前的那条注释 (JavaDoc)，它解释了该方法的作用。当我将鼠标悬停在它上面时可以查看它，就像我使用 String 语句时一样。
我知道这些注释在 Java 源代码中的 class 中。
但我认为将 Javadoc 留在文件中会破坏我的代码的易读性，所以问题是：有没有办法将这些 Javadoc 文档保存在单独的文件中，在我的代码中删除它们，但当我将鼠标悬停在我的方法中时它们仍然可见？
我已经尝试过 "Generate Javadoc"，但由于我在代码中删除了它，因此悬停功能不再起作用。
提前谢谢你。
JavaDocs 必须是内联的。当您考虑它时，这是有道理的。如果您要更改方法的签名或行为，而该方法的文档在其他文件中丢失，您很快就会得到不准确且无用的文档。人们会忘记更新它，或者他们会因为麻烦而故意避免这样做。
如果评论的长度让您感到厌烦，像 IntelliJ 这样的 IDE 将允许您折叠 JavaDocs（和任何其他块）以隐藏它们：
我已经有一段时间没有使用 Eclipse 了，但我怀疑它是一样的。
"Generate JavaDoc" 是一种解析您的 JavaDoc 注释并生成 HTML 的方法，可以单独浏览或托管在网页上，just like the classes from the JDK have.
顺便说一下，你有志于编写高质量的文档，真是太好了。世界需要更多这样的开发者。
不，不可能将 Javadoc 放在其他地方。 Javadoc 背后的整个思想是 "let's put the documentation directly into source code".
其背后的原因是，对于大多数开发人员来说，这与他们愿意查找文档的实际代码有多远，以及他们是否愿意去写一些。