Инструмент для вставки JSON в JavaDoc?

Question

Инструмент для вставки JSON в JavaDoc?

1

Я использую MireDot для создания документации для моей службы REST.

Хотя для создания моделей и общей информации о ресурсах это потрясающе, я не считаю, что в настоящее время он имеет способ "красиво" добавить конкретный пример ввода/вывода.

Тем не менее, я прибегаю к чистому JavaDoc для написания примеров Json. И это больно.

Кто-нибудь знает какой-либо инструмент, который помогает писать JavaDoc... и, в частности, упрощает вставку в него форматированного JSON/etc?

Ryan 18 март 2014, в 00:35

Источник

Теги:

java

json

api

documentation

javadoc

1 ответ

Ещё вопросы

Ryan · Accepted Answer · 2015-01-23T15-10-00.000Z

Это старый вопрос, который я опубликовал, когда я просто экспериментировал с документами API.

В конце концов я перешел на Пасека над MireDot, что делает эту задачу тривиальной. Причина этого перехода состояла в основном в том, чтобы отделить JavaDoc от фактической документации API, поскольку я обнаружил, что эти два могут создать очень грязную базу кода для сложного API, требующего много документации.

В идеале была бы построена документация с использованием всеобъемлющей платформы управления API, такой как Mashery или тому подобное, но в то время это не было вариантом.