Rozšíření pro BlueJ++ na příkladu editoru dokumentačních komentářů

Martin Jonák

Master's thesis

Extension for BlueJ++ by example of documentation comment editor

Abstract:

Tato práce si klade za hlavní cíl vytvořit editor dokumentačních komentářů pro jazyk Java. Tento editor je spustitelný samostatně, ale je možné ho integrovat do vývojového prostředí BlueJ.První teoretická část se zabývá tvorbou dokumentace softwaru. Tato část popisuje základní druhy softwarové dokumentace a později se podrobněji zaměří na dokumentaci zdrojového kódu.Druhá teoretická část se zaměřuje na oblast generátorů dokumentace a dokumentačních komentářů. Zvláštní pozornost je věnována prostředí jazyka Java a jeho generátoru dokumentace Javadoc. Práce popisuje možnosti úprav funkcionality nástroje Javadoc pomocí vlastních doplňků. Závěr teoretické části je věnován vývoji doplňků do vývojového prostředí BlueJ. Tato část se věnuje možnostem úprav programu pomocí vývoje externích doplňků. Bez nutnosti přímých zásahů do zdrojového kódu samotného prostředí BlueJ. Praktické část práce se soustředí na vývoj editoru dokumentačních komentářů. Závěr práce obsahuje podrobný manuál k použití vytvořeného nástroje.Vytvořená aplikace by měla usnadnit práci s dokumentačními komentáři. A rozšířit možnosti vývojového prostředí BlueJ.

Abstract:

This thesis aims to create a documentation comments editor for Java programing language. This editor is executable separately but can be integrated into the BlueJ development environment.The first theoretical part deals with the creation of software documentation. This section describes the basic types of software documentation and will later focus in detail on the source code documentation.The second theoretical part focuses on the field of documentation generators and documentation comments. Particular attention is paid to the Java environment and its Javadoc documentation generator. This work describes the possibilities to customize the Javadoc functionality using custom add-ons.Conclusion of the theoretical part is devoted to the development of extension to the BlueJ development environment. This section discusses how to customize the program by developing external add-ons. Without the need for direct changes in the source code of the BlueJ environment itself.The practical part of the thesis focuses on the development of documentation com-ments editor. The conclusion of the work contains a detailed manual for using the created tool.The created application should make it easier to work with documentation comments. And to extend the BlueJ IDE.

Keywords

Java, BlueJ, dokumentace softwaru, dokumentace zdrojového kódu, Javadoc

Keywords

BlueJ, software documentation, source code documentation, Java, Javadoc

Language used: Czech

Date on which the thesis was submitted / produced: 26. 3. 2018

Thesis defence

• Date of defence: 5. 6. 2019
• Supervisor: Rudolf Pecinovský
• Reader: Marek Chadim

Vysoká škola ekonomická v Praze

Master programme / field:
Aplikovaná informatika / Informační systémy a technologie