Написание тестов, которые служат образцом кода для пользователей вашего компонента
У нас есть компонент Reactjs ниже, который позволяет пользователям загружать и создавать карту, чтобы пользователи/разработчики могли использовать ее для прослушивания и обработки событий карты в своих собственных компонентах.
Теперь, чтобы объяснить нашим пользователям, как использовать этот компонент, мы пишем документацию.
Обычно используемый подход заключается в добавлении примера в файл readme или создании страницы документации с вариантами использования, в которых данный компонент может помочь.
Другой подход (который оказался очень эффективным, по крайней мере для меня) заключается в написании осмысленного теста.
Значимый тест – это тест, который подчеркивает/документирует/описывает основное назначение тестируемого компонента.
Ниже рассмотрен тест
По сути, это тот же пример в файле readme, но с дополнительным преимуществом, заключающимся в возможности запустить его для проверки/уверенности.
Знаете другие методы документирования? комментарий ниже!
Ресурсы:
