首页 > 解决方案 > 如何在生成的 API 文档中为每个类设置不同的 URL?

问题描述

我已经在 Github 页面上托管了我的项目生成的 API 文档,这非常好且简单。但是,我还想从我的站点链接到特定类的文档。我注意到默认实现是为整个文档使用相同的 URL,这使得无法链接到任何特定的内容。

例如,查看Google Guava 的 API 文档。无论您点击多少,URL 都保持不变。这使得无法链接到Lists具体的课程。这是否可以通过 javadocs 中的选项或 Github 页面中的选项来实现?

标签: javadocgithub-pages

解决方案


单击No Frames顶部栏正下方的按钮。在这种模式下,您的 url 将根据您访问的页面而变化。然后,您可以复制该链接并将其包含在您自己的文档中。(https://google.github.io/guava/releases/snapshot-jre/api/docs/com/google/common/collect/Lists.html)。

进入页面后,您还可以返回框架模式,并且docs/url 中的所有内容都将变成查询字符串。对于链接,我认为最好使用没有框架的链接。


推荐阅读