Задать вопрос

Как вы документируете API?

К примеру, мы пишем некую программу, и разумеется, все комментируется в коде. Отдельно мы можем структурировать все доступные интерфейсы и типы данных которые могут приниматься, к примеру в gedit, notepad, textmate или где-то еще. Но, есть ли сервисы или решения, которые помогают в этом? Хочется красиво и упорядочено организовать документацию. Так же, было бы здорово, поинтересоваться как решаете этот вопрос именно Вы.
  • Вопрос задан
  • 238 просмотров
Подписаться 2 Оценить Комментировать
Решения вопроса 2
DevMan
@DevMan
для внутреннего потребления - генерируем документацию по комментариям.
для внешнего потребления - первый пункт доводится до нужного состояния специальными людьми.
Ответ написан
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Но, есть ли сервисы или решения, которые помогают в этом?

doxygen?
swagger | blueprint | RAML (for REST API)?
single sourcing technical documentation?
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы