Как документировать файлы модульного теста javascript с помощью jsdoc?
Подход -p работает хорошо, но вы должны помнить об использовании его каждый раз. Если ваша цель - переключиться на более новую версию Python, это боль, а также может привести к ошибкам.
Другой вариант - установить переменную среды, которая выполняет ту же функцию, что и -p. Установите это через ваш файл ~/.bashrc или везде, где вы управляете переменными среды для сеансов входа в систему:
export VIRTUALENV_PYTHON=/path/to/desired/version
Затем virtualenv будет использовать это в любое время, когда вы не укажете -p в командной строке .
1 ответ
Документирование юнит-тестов не является подходящим и понятным способом. Проще говоря, я бы предпочел создать эффективные наборы тестов вместе с довольно четкими объяснениями, чтобы избежать какой-либо конкретной документации в тестах. После этого наборы тестов будут напоминать полную документацию, и они также расскажут о том, что делает текущий метод.
Вот пример, демонстрирующий вышеописанное с помощью Jest:
desscribe('<ComponentName />', () => {
describe('button click', () => {
it('calls exampleFunction', () => {
expect(exampleFunction).toHaveBeenCalled();
});
});
});
Я не эксперт по интеграционному тестированию, но если вы действительно хотите остаться в курсе документирования ваших тестов страница jsdoc довольно проста для меня.