Bakalářská práce se zaměřuje na vytváření nástroje a metodiky pro vytváření dokumentace PL/SQL kódu, který má stejnou syntaxi jako nástroj JavaDoc. Je popsáno, jak se nástroj implementoval a jak se má správně obsluhovat. Dále v práci jsou popsány vybrané, již vytvořené, nástroje pro vytváření dokumentace v oblasti programovacích jazyků i konkrétně zaměřené na jazyk PL/SQL. Zaměřuje se na jejich charakteristiku včetně výhod a nevýhod spojené s jejich užíváním.
Anotace v angličtině
Bachelor's thesis is focusing on creating tools and methodologies for creating documentation Pl/SQL code. The tool has the same syntax like JavaDoc tool. It is written how tool was implemented and how it should be manipulated correctly. In the thesis are described selected tools for creating documentation in an area of programming languages (including the ones focusing on PL/SQL language), which have already been created. Thesis is focused on their characteristic which includes pros and cons of their using.
Klíčová slova
PL/SQL, JavaDoc, dokumentace, databáze, Oracle
Klíčová slova v angličtině
PL/SQL, JavaDoc, documentation, database, Oracle
Rozsah průvodní práce
45 s.
Jazyk
CZ
Anotace
Bakalářská práce se zaměřuje na vytváření nástroje a metodiky pro vytváření dokumentace PL/SQL kódu, který má stejnou syntaxi jako nástroj JavaDoc. Je popsáno, jak se nástroj implementoval a jak se má správně obsluhovat. Dále v práci jsou popsány vybrané, již vytvořené, nástroje pro vytváření dokumentace v oblasti programovacích jazyků i konkrétně zaměřené na jazyk PL/SQL. Zaměřuje se na jejich charakteristiku včetně výhod a nevýhod spojené s jejich užíváním.
Anotace v angličtině
Bachelor's thesis is focusing on creating tools and methodologies for creating documentation Pl/SQL code. The tool has the same syntax like JavaDoc tool. It is written how tool was implemented and how it should be manipulated correctly. In the thesis are described selected tools for creating documentation in an area of programming languages (including the ones focusing on PL/SQL language), which have already been created. Thesis is focused on their characteristic which includes pros and cons of their using.
Klíčová slova
PL/SQL, JavaDoc, dokumentace, databáze, Oracle
Klíčová slova v angličtině
PL/SQL, JavaDoc, documentation, database, Oracle
Zásady pro vypracování
Cílem práce je vytvořit nástroj a metodiku pro vytváření dokumentace PL/SQL kódu. Nástroj bude umět analyzovat zdrojový kód balíčků, procedur a funkcí PL/SQL v prostředí ORACLE a na základě dokumentačních komentářů generovat dokumentaci ve formě HTML stránky. Nástroj musí podporovat stejnou syntaxi jako nástroj javadoc.
Vytvořený nástroj musí poskytovat GUI prostředí, které umožní nastavení všech parametrů dokumentace a výběr databázových objektů, ze kterých se bude dokumentace tvořit.
Teoretická část práce bude obsahovat rešerši v oblasti tvory dokumentace obecně pro všechny programovací jazyky a potom konkrétní zaměření na jazyk PL/SQL.
Zásady pro vypracování
Cílem práce je vytvořit nástroj a metodiku pro vytváření dokumentace PL/SQL kódu. Nástroj bude umět analyzovat zdrojový kód balíčků, procedur a funkcí PL/SQL v prostředí ORACLE a na základě dokumentačních komentářů generovat dokumentaci ve formě HTML stránky. Nástroj musí podporovat stejnou syntaxi jako nástroj javadoc.
Vytvořený nástroj musí poskytovat GUI prostředí, které umožní nastavení všech parametrů dokumentace a výběr databázových objektů, ze kterých se bude dokumentace tvořit.
Teoretická část práce bude obsahovat rešerši v oblasti tvory dokumentace obecně pro všechny programovací jazyky a potom konkrétní zaměření na jazyk PL/SQL.
Seznam doporučené literatury
* URMAN, Scott, Ron HARDMAN a Michael MCLAUGHLIN. Oracle: programování v PL/SQL. Vyd. 1. Překlad Jiří Fadrný. Brno: Computer Press, 2007, 720 s. ISBN 978-80-251-1870-2.
* CASTEEL, Joan. Oracle 11g: PL/SQL programming. 2nd ed., international ed. Australia: Course Technology, Cengage Learning, 2013. ISBN 978-128-5085-012.
* MCLAUGHLIN, Michael. Oracle database 11g PL/SQL programming. New York: McGraw-Hill, c2008, xxiv, 835 p. ISBN 00-714-9445-6.
* Javadoc Tool. [online]. [cit. 2014-10-03]. Dostupné z: http://www.oracle.com/technetwork/java/javase/documentation/javadoc-137458.html
Seznam doporučené literatury
* URMAN, Scott, Ron HARDMAN a Michael MCLAUGHLIN. Oracle: programování v PL/SQL. Vyd. 1. Překlad Jiří Fadrný. Brno: Computer Press, 2007, 720 s. ISBN 978-80-251-1870-2.
* CASTEEL, Joan. Oracle 11g: PL/SQL programming. 2nd ed., international ed. Australia: Course Technology, Cengage Learning, 2013. ISBN 978-128-5085-012.
* MCLAUGHLIN, Michael. Oracle database 11g PL/SQL programming. New York: McGraw-Hill, c2008, xxiv, 835 p. ISBN 00-714-9445-6.
* Javadoc Tool. [online]. [cit. 2014-10-03]. Dostupné z: http://www.oracle.com/technetwork/java/javase/documentation/javadoc-137458.html
Přílohy volně vložené
1 CD-ROM
Přílohy vázané v práci
ilustrace, tabulky
Převzato z knihovny
Ne
Plný text práce
Přílohy
Posudek(y) oponenta
Hodnocení vedoucího
Záznam průběhu obhajoby
Cílem práce bylo vytvořit nástroj a metodiku pro tvorbu dokumentace PL/SQL kódu. Dle vedoucího práce splnil student všechny požadavky dle zadání práce. Navržené řešení je dostatečně komplexní, aby bylo možné jeho použití v praxi. Student zdůraznil i potenciál pro další rozšíření, například formou šablon, nebo akceptací dalších tagů. Student při obhajobě výborně reagoval na dotazy a připomínky.