Как документировать файлы модульного теста javascript с помощью jsdoc?

Question

У меня есть реактивный проект, и я использую Jest для написания модульных и интеграционных тестов. Я хочу использовать jsdoc для документирования этих файлов.

Но не знаете как? не нашел ничего на странице jsdoc. Может ли кто-нибудь помочь мне с примером, если это возможно.

Answer 1

Документирование юнит-тестов не является подходящим и понятным способом. Проще говоря, я бы предпочел создать эффективные наборы тестов вместе с довольно четкими объяснениями, чтобы избежать какой-либо конкретной документации в тестах. После этого наборы тестов будут похожи на полную документацию, а также расскажут о том, что делает текущий метод.

Вот пример, демонстрирующий вышеприведенное с помощью Jest:

desscribe('<ComponentName />', () => {
   describe('button click', () => {
      it('calls exampleFunction', () => {
         expect(exampleFunction).toHaveBeenCalled();
      });
   });
});

Я не эксперт по интеграционному тестированию, но если вы действительно хотите документировать свои тесты, страница jsdoc довольно проста для меня.