如何在JavaDoc中定制“概述”页面？
我希望我的库的javadoc的“概述”页面本质上是整个JAR的用户/API指南。我知道添加一个包信息。javaclass to a package允许您编写包级别的javadocs，但是jar级别的呢？
我知道我可以在我的项目的根目录下放一个README. md，但是我喜欢把README看作是库开发人员（也就是维护库的人）的文档。但是JavaDocs是将使用库的人的应用编程接口指南。
共有2个答案
当您使用Maven及其JavaDoc插件时：
将名为overview.html的文件放入文件夹src/main/javadoc中，并运行命令mvn javadoc： javadoc；JavaDoc文件被写入文件夹目标/站点/apidocs中。
当您想为单元测试生成JavaDoc文件时，这也是可能的：将名为overview.html的文件放入文件夹src/test/javadoc中，并运行命令mvn javadoc： test-javadoc；JavaDoc文件被写入文件夹目标/站点/testapidocs中。
您可以创建一个概述超文本标记语言文件，并将其放置在源树中您喜欢的任何位置。惯例是overview.html调用它并将其放置在树的根部，但您肯定没有义务这样做。事实上，您可以为不同的目的创建多个概述文件。当您生成javadocs时，您使用-概述标志并将其传递到目标概述文件的路径。
您可以在此处找到有关概述文件要求的更多信息。
-
控制器层负责处理传入的请求, 并返回对客户端的响应。 为了创建一个基本的控制器，我们必须使用装饰器。多亏了他们，Nest 知道如何将控制器映射到相应的路由。 cats.controller.ts import { Controller, Get } from '@nestjs/common'; @Controller('cats') export class CatsController {
-
我正在制作一个自定义WordPress主题，其中我需要两种类型的页面。 一个索引页面，包含所有最近帖子的摘录。这个作品。（概述后页） 当你点击一个帖子的页面，显示帖子的全部内容。 现在，索引页面工作正常，并显示所有最近的帖子。但是当我点击一篇文章时，我会带着那篇文章进入索引页面模板。相反，我想转到另一个显示完整文章的页面模板。 我一直在尝试许多事情，寻找解决方案，但运气不好。我希望有人能帮助我。
-
问题内容： 我已经在我的应用程序上编写了广泛的JavaDoc文档，并在和文件中添加了许多有用的信息（包括前者到中的插图的链接）。Maven的Javadoc插件很好地使用了标准的javadoc工具来生成经典的JavaDoc框架集，但是现在我需要使用整个文档来生成PDF。 AurigaDoclet生成非常漂亮的PDF，我也能够使DocFlex正常工作。但是，它们都忽略了我和文件（在Maven内部和外部
-
问题内容： 我正在使用ant任务运行javadoc： 我想更改默认的index.html页面，以提供简短的用户指南。我可以更改index.html并将其复制到其他位置，并在完成javadoc的ant任务后将其重写，但这似乎有点愚蠢。有没有更通用的方法可以做到这一点？谢谢 问题答案： 您正在寻找javadoc的- overview选项。有关详细信息，请参见http://docs.oracle.com
-
每一次 Yii 应用开始处理 HTTP 请求时，它都会进行一个近似的流程。 用户提交指向 入口脚本 web/index.php 的请求。 入口脚本会加载 配置数组 并创建一个 应用 实例用于处理该请求。 应用会通过 request（请求） 应用组件 解析被请求的 路由。 应用创建一个 controller（控制器） 实例具体处理请求。 控制器会创建一个 action（动作） 实例并为该动作执行相关
-
MySQL复制基于主服务器在二进制日志中跟踪所有对数据库的更改(更新、删除等等)。因此，要进行复制，必须在主服务器上启用二进制日志。参见5.11.3节，“二进制日志”。 每个从服务器从主服务器接收主服务器已经记录到其二进制日志的保存的更新，以便从服务器可以对其数据拷贝执行相同的更新。 认识到二进制日志只是一个从启用二进制日志的固定时间点开始的记录非常重要。任何设置的从服务器需要主服务器上的在主服务