JavaDocs - 为每个部分添加超链接并为每个 html 文件包含一个脚本标记答案

【问题标题】：JavaDocs - adding hyperlink to each section and including a script tag for each html fileJavaDocs - 为每个部分添加超链接并为每个 html 文件包含一个脚本标记
【发布时间】：2019-07-11 08:33:42
【问题描述】：

所以我使用这个插件来生成 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
我需要在生成的 javadocs 的每个 html 文件中包含一个 javascript 标记。有没有办法告诉插件在每个 html 文件中包含这个脚本标签？在<head>?或者真的在任何地方，因为它是为了造型。

例如，为了解决 #2，我尝试在项目中的每个类上方添加以下内容：

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

但这似乎不起作用，脚本标签没有被添加到 html 中。

【问题讨论】：

这里是 javadoc 插件文档的链接：maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html

标签： html maven javadoc maven-javadoc-plugin

【解决方案1】：

为了解决 #2，我刚刚做了一个 hack。我将 google-code-prettify 库中的源代码复制到了已由 javadoc 页面加载的共享 .js 文件中。

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

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

【讨论】：

【解决方案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 的任何页面。

【讨论】：