madrogalo
@madrogalo
Кратко о себе

Как вести документацию для react компонетов?

С ростом проекта приходит необходимость в документации react компонентов.
Что использовать для документации компонентов?
Поделитесь пожалуйста своим опытом
  • Вопрос задан
  • 1107 просмотров
Пригласить эксперта
Ответы на вопрос 2
iCoderXXI
@iCoderXXI
React.JS/FrontEnd engineer
Документировать надо, в первую очередь, бизнес-логику
Ответ написан
Комментировать
alexiusp
@alexiusp
senior frontend developer
Смотря что вы имеете в виду под документацией и как именно организован проект. Как правильно написали выше - самое главное это документировать логику. Как именно это делать зависит от команды - как удобнее. Скорее всего вы придёте к ридми в репозиториях и/или документам в гуглодоках или конфлюэнс.

Если у вас проект настолько разросся, что обзавёлся стайл гайдом и настала пора выносить компоненты в отдельную библиотеку, то можно и эту библиотеку задокументировать. Для этих целей мне лично нравится React Styleguidist. Но вам он может и не подойти. Есть и другие альтернативы, достаточно погуглить и попробовать каждую, чтобы понять какая вам удобнее.
Ответ написан
Комментировать
Ваш ответ на вопрос

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

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