Nástroje pro automatizovanou tvorbu dokumentace kódu v prostředí .NET

Karla SLADKÁ

Bakalářská práce

Tools for automated creation of source code documentation in the .NET environment

Anotace:

Bakalářská práce představí nástroje pro automatizovanou tvorbu dokumentace z prostředí .NET. Práce se zabývá běžně dostupnými nástroji a jejich popisem. Demonstruje jejich výstup a porovnává jejich kvalitu. Tato problematika je rozdělena do čtyř základních částí. Úvodní část se zabývá softwarovou dokumentací a problematikou generování dokumentace z kódu. V následující části jsou představeny nástroje pro automatizované generování dokumentace kódu z prostředí .NET. Poslední část se věnuje stanovením metrik popisující možnosti tvorby, vlastnosti a výstup u vybraných nástrojů. Dále se vytvoří komplexní příklad pro demonstrování práce s nástroji a výslednou dokumentací, které se ohodnotí podle stanovených metrik. V závěru kapitoly jsou shrnuty výsledky hodnocení a srovnání.

Abstract:

This bachelor thesis is going to introduce tools for automatic creation of documentation in .NET environment. Thesis is dealing with commonly accessible tools and it?s description. It demonstrates their output and compares its quality. This problem is divided into four main parts. Introduction part is dealing with software documentation and generation of documentation from code issues. In the next part are tools for automated generation of code documentation from .NET environment introduced. The last part is dedicated to specifying metrics, describing possibility of creation, properties and output in chosen tools. Further the complex example for thesis demonstration with tools and final documentation, which is evaluated with respect to chosen metrics, is created. In conclusion of this chapter are summarized results of evaluation and comparison.

Klíčová slova

Dokumentace, generovaní, Sandcastle, Document! X, NDoc, Doxygen, .NET

Jazyk práce: čeština

Datum vytvoření / odevzdání či podání práce: 22. 4. 2013

Zveřejnit od: 22. 4. 2013

Obhajoba závěrečné práce

• Vedoucí: RNDr. Marek Vajgl, Ph.D.

OSTRAVSKÁ UNIVERZITA V OSTRAVĚ

Přírodovědecká fakulta

Bakalářský studijní program / obor:
Aplikovaná informatika / Informatika a výpočetní technika - aplikovaná informatika