Документирование публичного интерфейса сборок

Question

Правила управления версиями программного обеспечения рекомендуют увеличивать ОСНОВНУЮ ВЕРСИЮ, когда происходят серьезные изменения в общедоступном API.

Я пытался использовать Class View в Visual Studio и приложениях, таких как dotPeek, но до сих пор не смог найти способ экспортировать список всех открытых элементов сборки в обычный текст или XML. Кто-нибудь знает хороший способ сделать это?

Answer 1

Я создал пакет NuGet для этого. http://www.nuget.org/packages/ApiApprover/

По сути, он генерирует ваш общедоступный API в виде большой строки, а затем передает его на утверждение для проверки.

Сертификационные тесты работают, не пройдя тест, если полученный и утвержденный текст отличаются. Если он отличается, он может вызвать инструмент слияния, чтобы вы могли просмотреть измененные и принять их. Одобрение тестов казалось идеальным решением этой проблемы, я просто обернул вокруг него генерацию публичного API.