У меня есть требование создать файл doc каждого из компонентов мы определяем в нашем приложении reactjs. Я ищу npm, что мы может использоваться для создания документа любого расширения, чтобы он мог извлекать код, комментировать все из моего компонента и изменять его к документу любого расширения. Как я могу это сделать, пожалуйста, помогите мне? Мой вопрос отличается от другого вопроса, связанного с jsdoc, потому что я ищу документацию в actionsjs с помощью jsdoc.
Как сделать документацию в ReactJS?
Ответ 1
Наконец, я нашел решение. Сначала перейдите по этой ссылке и правильно прочитайте документ: Читать документ Теперь выполните следующие действия: -
Откройте командную строку Установите JSDoc глобально по команде: npm install jsdoc -g Теперь перейдите в путь к папке проекта и запустите команду: jsdoc src -r -d docs Выше команда создаст документ в папке doc каталога вашего проекта.Ответ 2
Мы документируем нашу библиотеку компонентов React с помощью React Styleguidist.
Он проанализирует ваш код со следующими функциями:
- генерировать документы API/props из определенных вами типов PropTypes.
- Создавайте живые редактируемые примеры документации, которая позволяет людям легко скопировать фрагмент кода.
- Он довольно хорошо настраивается и имеет горячую перезагрузку для получения внутренних документов.
Он работает путем создания веб-приложения через Webpack, которое вы можете использовать локально или где-то для всех своих разработчиков.
Для нас это работает довольно хорошо, и они улучшают его с течением времени.
Изменение: Использует Reaction-Docgen под капотом.
Ответ 3
Попробуйте этот пакет, на котором есть примеры для понимания.
Он предоставляет реализацию по умолчанию для компонентов React, определенных с помощью определений или функций класса React.createClass, ES2015 (компоненты без состояния). Эти определения компонентов должны следовать определенным рекомендациям, чтобы их можно было анализировать (см. Ниже дополнительную информацию).
Ответ 4
У нас есть много реагирующих компонентов libs и используйте react-showroom
Он позволяет писать документацию в методе уценки и иметь песочницу. Большое преимущество этого - вы можете запустить новый проект за две минуты с уже настроенным webpack, babel, lint и т.д.
Очень рекомендую попробовать.
Ответ 5
Я написал небольшую обертку для реакции-docgen, которая делает ее более простой в использовании. Он экспортирует файл отметки для всех компонентов в переданной папке.
Оформить проект https://github.com/LaustAxelsen/wilster-doc
Ответ 6
В JSDoc есть тема под названием better-docs, и в ней есть плагин @component. Когда вы добавите его в свой компонент (как и любые другие теги), он проанализирует все ваши propTypes и сгенерирует документацию. Кроме того, когда вы используете его вместе с тегом @example, лучше-docs напечатает предварительный просмотр в реальном времени.