Generátor dokumentace ze Spring Boot konfiguračních tříd

Abstract

Tato práce se zabývá hledáním možných řešení pro automatické generování dokumentace z konfiguračních tříd Java Spring Boot projektů. Nalezená řešení jsou porovnána a následně je realizována implementace jednoho z nich. Cílem je vytvoření nástroje, který bude možné snadno zapojit do stávajícího Java projektu. Na úvod jsou představeny technologie související s problematikou Spring Boot projektů, jejich konfigurací a dokumentací. Dále jsou popsány možné přístupy k řešení a jejich porovnání. Při výběru vhodného řešení je kladen důraz na jednoduchost návrhu, implementaci a případnou rozšiřitelnost výsledného nástroje. Následně se již práce věnuje návrhu a výsledné implementaci. Výsledkem je nástroj, který je možné snadno spustit ve stávajícím Java Spring Boot projektu. Nástroj provede analýzu zdrojového kódu a z dostupné programátorské dokumentace, která se nachází ve zdrojovém kódu v podobě Javadoc komentářů, vygeneruje dokumentaci konfigurovatelných hodnot aplikace.

This thesis examines possible solutions for the automatic generation of documentation from configuration classes of Java Spring Boot projects. The solutions found are compared, and then an implementation of one of them is realized. The goal is to create a tool that can be easily integrated into an existing Java project. Initially, technologies related to the issues of Spring Boot projects, as well as their configuration and documentation, are presented. Next, possible approaches to the solution are described and compared. When selecting a suitable solution, the focus is on simplicity of design, implementation, and possible extensibility of the resulting tool. Subsequently, the work focuses on the design and the resulting implementation. The result is a tool that can be easily run in an existing Java Spring Boot project. It performs an analysis of the source code and generates documentation of configurable values from the available Javadoc comments.