我可以在 IntelliJ IDEA 中查看实现的 javadoc 而不是接口吗？
我在我的 Intellij IDEA 项目中使用第三方库。当我在方法名称上添加插入符号时，我可以按 Ctrl-Q 在“快速文档查找”窗口中获取 javadoc，但仅显示方法签名。这是因为包含该方法的对象类型是没有 javadoc 注释的接口。该对象的实际实现确实有 javadoc 注释。如果我将对象转换为实现类型，则会出现 javadoc 注释。 我可以在 IntelliJ 中做一些事情来让它工作而不需要更改任何代码吗？
I am using a third party library in my Intellij IDEA project. When I have the caret on a method name I can hit Ctrl-Q to get javadoc in the 'Quick Documentation Lookup' window, however only the method signature is displayed. This is because the type of object containing the method is an Interface with no javadoc comments. The actual implementation of the object does have javadoc comments. If I cast the object to the implementation type the javadoc comments will appear.
Can I do something in IntelliJ get this to work without making any code changes?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
抱歉，这不会有太大帮助。但我想知道：
为什么有人会记录实现类而不记录接口？接口记录了契约，这通常就足够了，实现类当然可以吹嘘它实现契约的效果如何，或者说明它破坏契约的原因，但在 90% 的情况下，
{@inheritDoc} 标签对于实现方法就足够了，而接口应该定义方法语义。这样做的原因之一就是您刚刚遇到的原因：针对接口开发代码的人（我希望我们都是）需要记录这些接口。如果我需要查找实现类的功能，为什么还要费心去寻找接口呢？
当然，也有例外情况，应该记录实现方法（见上文），当然，应该始终记录实现类和构造函数，但在我看来，具有未记录接口的 API 是一个糟糕的 API。
Sorry, this won't be much help. But I am wondering:
why would anybody document the implementing classes but not the interface? The interface documents the contract, that should usually be enough, and an implementing class can of course brag how well it implements the contract or state why it breaks it, but in 90% of the cases an
{@inheritDoc}tag is enough for an implementation method, while the interface should define the method semantics.One of the reasons to do it that way is the one you are just encountering: people who develop code against interfaces (and I hope we all are) need these interfaces to be documented. If I need to look up the functionality of the implementing classes, why bother with interfaces at all?
Of course there are exceptions where implementing methods should be documented (see above), and of course the implementing classes and constructors should always be documented, but an API with undocumented interfaces is in my opinion a bad API.