将 JSON 插入 JavaDoc 的工具？ [关闭]

Question

我正在使用 MireDot 为我的 REST 服务生成文档。

虽然生成模型和资源的一般信息非常棒，但我不相信它目前有一种“很好地”添加具体示例输入/输出的方法。

也就是说，我正在使用纯 JavaDoc 来编写 Json 示例。而且很痛苦。

是否有人知道那里有任何工具可以帮助编写 JavaDoc...，尤其是可以轻松地将格式化的 JSON/etc 插入其中？

Answer 1

这是我刚刚尝试记录 API 的方法时发布的一个老问题。

最终我通过 MireDot 切换到 Apiary，这使得这项任务变得微不足道。这种转变的原因主要是为了将 JavaDoc 与实际的 API 文档分离，因为我发现将这两者结合起来会为需要大量文档的复杂 API 创建一个非常混乱的代码库。

理想情况下，应该使用诸如 Mashery 之类的包罗万象的 API 管理平台来构建文档，但当时这不是一个选择。