java - 使用 Javadoc 生成 API 文档

Question

我正在为我正在处理的项目编写 Javadocs，并希望利用@link标签将每个端点链接到为每个方法生成的 javadoc。

理想情况下，我想做与此类似的事情：

POST /api/resources      calls {@link Resource#getAll()     Resource@getAll}
GET  /api/resources/{id} calls {@link Resource#getById(int) Resource#getById}

我对任何类似的解决方案都持开放态度。

Answer 1

Maven 有一个功能允许您在其中编写 HTML 标记，src/main/javadoc/overview.html它将处理所有 Javadoc 标记并将输出写入 Javadoc 主页面。

如果您使用 markdown 生成 overview.html 页面，这非常有效