Для JavaScript в течение длительного времени и все еще используемого в настоящее время есть JSdoc3 .
JSDoc 3 - это генератор документации API для JavaScript, похожий на Javadoc или phpDocumentor.Вы добавляете комментарии к документации непосредственно в свой исходный код, прямо рядом с самим кодом.Инструмент JSDoc отсканирует ваш исходный код и создаст для вас веб-сайт с документацией HTML.
Но похоже, что поддержка этого хранилища в настоящее время выглядит мертвой, но все еще используется многими людьми.
Существуют и другие альтернативы:
- yuidoc
YUIDoc - это приложение Node.js, которое генерирует документацию API из комментариев в источнике, используя синтаксиспохож на такие инструменты, как Javadoc и Doxygen.
- apidoc (но более сфокусированный на RESTful API)
Встроенная документация для веб-API RESTful apiDoc создаетдокументация по аннотациям API в вашем исходном коде.
Теперь, если вы ищете что-то более интегрированное с React / Components и игровой площадкой, где пользователи могут поиграть с ипросмотреть живой код, есть другие варианты (более ориентированные компоненты пользовательского интерфейса):
- React Styleguidist
Изолированный компонент React dсреда разработки с руководством по стилю жизни
- Сборник рассказов
Сборник рассказов - это среда разработки пользовательского интерфейса и игровая площадка для компонентов пользовательского интерфейса.Инструмент позволяет пользователям создавать компоненты независимо и интерактивно демонстрировать компоненты в изолированной среде разработки.
- Docz
Сегодня инструменты, которые позволяют намБыть быстрым и эффективным в том, что мы делаем, действительно необходимо.Мы не можем позволить себе терять время с задачами, которые должны быть тривиальными.Вот почему был создан docz.
Docz и Styleguidist имеют игровые площадки, где пользователи могут поиграть с ними и просмотреть живой код и автоматические таблицы, которые считывают проптипы компонентов.Документация написана в файле MDX для первого и простой уценкой для второго.Docz может быть самым простым в использовании, но все они могут соответствовать вашим потребностям.
Для Storybook я знаю, что это отличный инструмент, но я никогда не использовал его, поэтому могу рассказать вам больше об этом.
JSDocs также можно использовать для документирования компонентов, но без интерактивного состояния.