Как создать документацию для светильников в тестах Fitnesse
Я работаю в проекте, который использует Fitnesse несколько лет. Одной из важных тем является обслуживание и добавление новых тестов. Во избежание дублирования хорошо иметь некоторую документацию для существующих fixtures,
Знаете ли вы инструменты, которые могут генерировать документацию для fixtures от C# или же C++ код?
Решение
В основном я работаю на Java и сталкивался с командами, которые генерировали документацию для своих приборов на основе JavaDoc (эквивалент xmldoc). Они создали собственный исходный постпроцессор, который генерировал вики-страницы с описанием каждого прибора и каждого метода на основе этих комментариев.
Я уверен, что нечто подобное может быть создано (если оно еще не существует) для среды .Net.
Мой личный опыт показывает, что написание документации для приборов выходит за рамки того, что я могу достичь в комментариях к моему коду. Для каждого из основных приборов в моей библиотеке с открытым исходным кодом я создал обзорную страницу со списком всех методов (определите язык, специфичный для предметной области), а ниже я добавил несколько примеров тестовых страниц, показывающих приборы в действии. Кроме того, я создаю приемочные тесты FitNesse для своих приборов, которые также предоставляют документацию (своего рода). Все это ручная работа, которая, как я считаю, важна, чтобы люди могли пользоваться приспособлениями.
Поэтому я полагаю, что вы, вероятно, получите лучшую документацию, потратив время на написание документации вручную, чем потратив ее на настройку генератора и обеспечение правильного ввода в коде ваших приборов … Только мои 2cts.
Другие решения
Других решений пока нет …