使用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有一个功能，允许您在src/main/javadoc/overview.html中编写HTML标记，它将处理所有Javadoc标记并将输出写入主Javadoc页面。

如果您使用markdown生成overview.html页面

，则效果非常好