代码之家  ›  专栏  ›  技术社区  ›  Ryan A.

使用Javadoc生成API文档

  •  0
  • Ryan A.  · 技术社区  · 13 年前

    我正在为我正在进行的一个项目编写Javadocs,并希望利用 @link 标记将每个端点链接到为每个方法生成的javadoc。

    理想情况下,我想做一些类似的事情:

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

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

    1 回复  |  直到 13 年前
        1
  •  0
  •   Ryan A.    13 年前

    Maven有一个功能,允许您在 src/main/javadoc/overview.html 它将处理所有的Javadoc标签,并将输出写入主Javadoc页面。

    如果您使用markdown生成overview.html页面,这一操作效果非常好