Question

可以将JDK文档继承到生成Javadoc时已覆盖/实现的方法中。（例如this SO question。）

这可以通过将包含JDK源的目录添加到Javadoc -sourcepath来实现。我假设如果我解压缩任何库依赖项的源代码将会发生同样的事情。

是否可以在不解压缩所有源代码的情况下继承文档？这将允许使用我可以从Ivy / Maven或其他任何方式创建的路径的完整文档。

也许有可能欺骗Javadoc使用某种拉链路径？

我意识到我可以链接到网络上的其他文档 - 也很有用，但不同。

Answer 1

使用{@inheritDoc}代码明确继承评论 - 在方法主要说明或{@inheritDoc}，@return或@param代码评论中插入内联代码@throws - 相应的继承主要描述或标签注释被复制到该位置。

继承方法的源文件只需要在-sourcepath指定的路径上，以便文档注释可以实际复制。无需在命令行中传递类及其包。

Answer 2

我正在使用我的maven项目配置完成此操作，以便链接的核心java文档始终与我的编译版本匹配。我想链接selenium的所有文档，因为这是一个严重依赖它的页面对象框架的一部分。我相信我们可以根据你的设置调整这种方法。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <links>
            <link>http://seleniumhq.github.io/selenium/docs/api/java/</link>
            <link>https://docs.oracle.com/javase/${project.java.version}/docs/api/</link>
        </links>
    </configuration>
</plugin>

它的核心与使用javadoc的命令行选项链接到Web上的内容相同，例如您链接的the answer to this question。只需要参数化它链接到的URL。

对于命令行javadoc，我认为这样翻译（unix 语法，一行）：
javadoc -sourcepath ../example-src/src:src
        -d docs
        -link http://example.com/javadoc/
        -subpackages com.personal.myproject
        (other options...)

<小时/> 卫生署！刚刚意识到这一切都假设您的外部库在某处托管他们的文档。我想如果不是这样的话，也许你可以探索为外部库生成一个javadoc jar并用jar样式uri进行链接。至少那时你只为项目引入一个新工件。

Answer 3

在JDK 1.8.0u121中，-sourcepath接受ZIP文件，例如JDK本身附带的src.zip。

从归档文件中的库继承javadoc

3 个答案: