Недавно мне попалась необычная задача получить доступ к комментариям кода в рантайм.
![][1]
Это поможет поймать сразу 3х зайцев — кроме документации в коде проекта из тестов проекта легко будет сгенерировать sequence diagram, которые смогут читать аналитики, а QA сможет сравнить свои тест планы с автотестами проекта и дополнить их при необходимости. Появляется общий язык в команде между теми кто пишет код и теми кто не может его читать. Как результат — лучшее понимание проекта всеми в процессе разработки ну и с точки зрения разработчика не нужно рисовать ничего вручную — код и тесты первичны. Больше шансов что такая документация будет самой актуальной на проекте, так как генерируется из работающего кода. Заодно дисциплинирует разработчика документировать классы и методы, которые участвуют в диаграммах.
В этой публикации я расскажу как же извлечь javadoc из исходного кода проекта.
[И в финале распотрошим документацию Spring Boot][2]
[1]:
https://habrastorage.org/web/403/abf/8b7/403abf8b7d194cb184170eb95171b51b.jpg
[2]:
https://habrahabr.ru/post/336732/?utm_source=habrahabr&utm_medium=rss&utm_campaign=feed_posts#habracut