Cieľom tejto práce je priblížiť čitateľom potrebu dokumentácie a zlepšiť im povedomie ohľadom tejto problematiky. Táto práca približuje samotnú dokumentáciu, ako k nej pristupovať a postupovať pri jej tvorbe a ako efektívnejšie dokumentovať zdrojový kód programov pomocou generátorov dokumentácie. Okrem iného obsahuje prehľady a ukážky dostupných generátorov, ich porovnanie a odporúčanie pre výber vhodného generátoru.
Anotace v angličtině
The primary focus of this work is to inform readers about the necessity of documentation, and to improve their awareness of this issue. This work draws closer the documentation itself, how to access the documentation and proceed with its creation, and how to document the source code of programs more effectively using generators for documentation. Moreover, the documentation includes overviews and examples of available generators, their comparison, and recommendations for selecting a suitable generator.
Cieľom tejto práce je priblížiť čitateľom potrebu dokumentácie a zlepšiť im povedomie ohľadom tejto problematiky. Táto práca približuje samotnú dokumentáciu, ako k nej pristupovať a postupovať pri jej tvorbe a ako efektívnejšie dokumentovať zdrojový kód programov pomocou generátorov dokumentácie. Okrem iného obsahuje prehľady a ukážky dostupných generátorov, ich porovnanie a odporúčanie pre výber vhodného generátoru.
Anotace v angličtině
The primary focus of this work is to inform readers about the necessity of documentation, and to improve their awareness of this issue. This work draws closer the documentation itself, how to access the documentation and proceed with its creation, and how to document the source code of programs more effectively using generators for documentation. Moreover, the documentation includes overviews and examples of available generators, their comparison, and recommendations for selecting a suitable generator.
Popište základní přístupy k vytváření dokumentace ke zdrojovým kódům programů.
Uveďte základní postupy používané pro automatizovanou tvorbu dokumentace zdrojových kódů
Vytvořte přehled dostupných generátorů dokumentace zdrojových kódů, včetně jejich podstatných vlastností.
Podrobně popište nejčastěji používané generátory, uveďte ukázky jejich použití.
Srovnejte vybrané generátory a vytvořte návod, který bude sloužit jako pomůcka pro výběr vhodného generátoru.
Zásady pro vypracování
Popište základní přístupy k vytváření dokumentace ke zdrojovým kódům programů.
Uveďte základní postupy používané pro automatizovanou tvorbu dokumentace zdrojových kódů
Vytvořte přehled dostupných generátorů dokumentace zdrojových kódů, včetně jejich podstatných vlastností.
Podrobně popište nejčastěji používané generátory, uveďte ukázky jejich použití.
Srovnejte vybrané generátory a vytvořte návod, který bude sloužit jako pomůcka pro výběr vhodného generátoru.
Seznam doporučené literatury
GAROUSI, Golara, Vahid GAROUSI-YUSIFO?LU, Guenther RUHE, Junji ZHI, Mahmoud MOUSSAVI a Brian SMITH. Usage and usefulness of technical software documentation: An industrial case study.Information and Software Technology \matsymb{lbrack}online\matsymb{rbrack}. 2015, 57, 664-682 \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. DOI: 10.1016/j.infsof.2014.08.003. ISSN 09505849.
ZANONI, Julio Cezar, Milton Pires RAMOS, Cesar Augusto TACLA, Gilson Yukio SATO a Emerson Cabrera PARAISO. A semi-automatic source code documentation method for small software development teams. In: Proceedings of the 2011 15th International Conference on Computer Supported Cooperative Work in Design (CSCWD) \matsymb{lbrack}online\matsymb{rbrack}. IEEE, 2011, s. 113-119 \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. DOI: 10.1109/CSCWD.2011.5960063. ISBN 978-1-4577-0386-7.
Comparison of documentation generators. In: Wikipedia: the free encyclopedia \matsymb{lbrack}online\matsymb{rbrack}. San Francisco (CA): Wikimedia Foundation, 2001- \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. Dostupné z: https://en.wikipedia.org/wiki/Comparison_of_documentation_generators
Doxygen \matsymb{lbrack}online\matsymb{rbrack}. \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. Dostupné z: http://www.stack.nl/ dimitri/doxygen/
TOOLS TO GENERATE BEAUTIFUL WEB API DOCUMENTATION. SILVERMAN, Matt. MATTSILVERMAN \matsymb{lbrack}online\matsymb{rbrack}. 2013 \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. Dostupné z: http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
Seznam doporučené literatury
GAROUSI, Golara, Vahid GAROUSI-YUSIFO?LU, Guenther RUHE, Junji ZHI, Mahmoud MOUSSAVI a Brian SMITH. Usage and usefulness of technical software documentation: An industrial case study.Information and Software Technology \matsymb{lbrack}online\matsymb{rbrack}. 2015, 57, 664-682 \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. DOI: 10.1016/j.infsof.2014.08.003. ISSN 09505849.
ZANONI, Julio Cezar, Milton Pires RAMOS, Cesar Augusto TACLA, Gilson Yukio SATO a Emerson Cabrera PARAISO. A semi-automatic source code documentation method for small software development teams. In: Proceedings of the 2011 15th International Conference on Computer Supported Cooperative Work in Design (CSCWD) \matsymb{lbrack}online\matsymb{rbrack}. IEEE, 2011, s. 113-119 \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. DOI: 10.1109/CSCWD.2011.5960063. ISBN 978-1-4577-0386-7.
Comparison of documentation generators. In: Wikipedia: the free encyclopedia \matsymb{lbrack}online\matsymb{rbrack}. San Francisco (CA): Wikimedia Foundation, 2001- \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. Dostupné z: https://en.wikipedia.org/wiki/Comparison_of_documentation_generators
Doxygen \matsymb{lbrack}online\matsymb{rbrack}. \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. Dostupné z: http://www.stack.nl/ dimitri/doxygen/
TOOLS TO GENERATE BEAUTIFUL WEB API DOCUMENTATION. SILVERMAN, Matt. MATTSILVERMAN \matsymb{lbrack}online\matsymb{rbrack}. 2013 \matsymb{lbrack}cit. 2017-11-11\matsymb{rbrack}. Dostupné z: http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
Přílohy volně vložené
CD ROM
Přílohy vázané v práci
-
Převzato z knihovny
Ne
Plný text práce
Přílohy
Posudek(y) oponenta
Hodnocení vedoucího
Záznam průběhu obhajoby
Diplomant odprezentoval před komisí hlavní cíle a výsledky své bakalářské práce. Prezentace jako celek působila velmi dobrým dojmem, jednotlivé snímky prezentace graficky i obsahově vyvážené. Následně byl student seznámen s posudky vedoucího a oponenta bakalářské práce. Diplomant postupně odpověděl na otázky oponenta práce.
Komise vznesla k obhajobě následující dotazy:
1) Prof. Vašek: Umí program komentovat kód napsaný v jazyce symbolických adres?
2) Prof. Vašek: Zkoušel jste někdy okomentovat cizí program?
3) Doc. Chramcov: Kolik z testovaných programů je zdarma?
Student odpovídal na dotazy na velmi dobré úrovni.