Question

所以我正在使用此插件生成javadocs：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>3.0.1</version>
    <executions>
        <execution>
            <id>attach-sources</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

并生成我使用的文档：mvn javadoc:javadoc

我得到这样的东西：

我有两个问题：

是否可以在HTML部分中放置<a>或<div>，以便可以使用此技术将其超链接？ https://stackoverflow.com/a/2835151/1223975
我需要在每个html文件中为生成的javadocs包含一个javascript标记。有没有办法告诉插件在每个HTML文件中包含此脚本标签？在<head>中？甚至在任何地方，因为它都是用于样式的。

例如，要解决第二个问题，我尝试将其添加到项目中每个类的上方：

/*
 * <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
 **/
public class Foo {}

但这似乎不起作用，脚本标记未添加到html中。

Answer 1

为了解决＃2，我只是做了一个破解。我将源代码从google-code-prettify库复制到了Javadoc页面已加载的共享.js文件。

https://rawgit.com/google/code-prettify/master/loader/run_prettify.js

我将上面的代码从链接复制到了一个.js文件中，并复制到target/site/apidocs/script.js中。如果javadoc格式更改，这不是一个很好的解决方案，但现在可以使用。如果可能的话，我希望可以在我的javadoc注释中随意声明<script>标签。

Answer 2

我发现＃2，所以我的语法是错误的，而不是这样：

/*
 * <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
 **/
public class Foo {}

应为：

/**
 * <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
 */
public class Foo {}

然后它将在脚本所在的任何页面上将脚本加载到该脚本中。

JavaDocs-将超链接添加到每个部分，并包括每个html文件的脚本标签

2 个答案: