【问题标题】:Can I view the javadoc for an implementation rather than the interface in IntelliJ IDEA?我可以查看实现的 javadoc 而不是 IntelliJ IDEA 中的接口吗?
【发布时间】:2010-05-24 10:30:10
【问题描述】:

我在我的 Intellij IDEA 项目中使用第三方库。当我在方法名称上有插入符号时,我可以按 Ctrl-Q 在“快速文档查找”窗口中获取 javadoc,但是只显示方法签名。这是因为包含该方法的对象类型是一个没有 javadoc cmets 的接口。对象的实际实现确实有 javadoc cmets。如果我将对象转换为实现类型,则会出现 javadoc cmets。 我可以在 IntelliJ 中做一些事情来让它工作而不做任何代码更改吗?

【问题讨论】:

    标签: java intellij-idea javadoc


    【解决方案1】:

    抱歉,这不会有太大帮助。但我想知道:

    为什么有人会记录实现类而不记录接口?接口记录了契约,这通常就足够了,实现类当然可以吹嘘它实现契约的能力或说明它为什么会破坏契约,但在 90% 的情况下,{@inheritDoc} 标记对于实现来说就足够了方法,而接口应该定义方法语义。

    这样做的原因之一就是您刚刚遇到的原因:针对接口开发代码的人(我希望我们都是)需要记录这些接口。如果我需要查看实现类的功能,为什么还要麻烦接口呢?

    当然也有例外情况应该记录实现方法(见上文),当然实现的和构造函数应该始终记录在案,但在我看来,具有未记录接口的 API糟糕的 API。

    【讨论】:

    • 同意,但是源中的接口例如geronimo-jms_1.1_spec-1.1.1.jar 没有文档,尽管例如activemq-core-5.2.0.jar do :-(。我确实想要特定实现的文档,因为它实现了许多扩展顶级接口的接口之一。
    • 那么恐怕你要么将实现类型用作变量类型(啊,不好的做法),要么编写自己的想法插件(啊,不必要的工作)
    猜你喜欢
    • 2012-06-18
    • 2018-04-04
    • 2011-03-26
    • 2015-02-07
    • 2011-06-30
    • 1970-01-01
    • 2021-02-02
    • 1970-01-01
    • 2016-12-14
    相关资源
    最近更新 更多