Automatic PL/SQL Code Documentation: Methodology and Tools

Radosław Zegadło

Abstract

The Master or Science dissertation begins with introduction to Oracle RI)BMS and PL/SQL stored procedures language including syntax basics and problems with code documentation. The following chapters focus on code documentation methodology and creation of application supporting automatic documentation generation. Firstly, the dissertation presents proposed documentation comments standard. Next parts concentrate upon PL/SQL code analysis. There are described formal PL/SQL grammar used in the project, its modifications made by the author, lexers and parsers generator Antlr and its integration with PLSQLDoxy application. The further chapters contains description of LaTeX documentation generation and mechanism of creating PL/SQL program units documentation in Enterprise Architect environment. The dissertation ends with suinniary of achieved goals and perspectives of further development.
Diploma typeMaster of Science
Author Radosław Zegadło (FEIT / IN)
Radosław Zegadło,,
- The Institute of Computer Science
Title in PolishAutomatyczne dokumentowanie kodu PL/SQL: metodyka i oprogramowanie
Supervisor Michał Rudowski (FEIT / IN)
Michał Rudowski,,
- The Institute of Computer Science
Certifying unitFaculty of Electronics and Information Technology (FEIT)
Affiliation unitThe Institute of Computer Science (FEIT / IN)
Languagepl polski
StatusFinished
Issue date (year)2011
Internal identifierENII-PM.001460
Keywords in PolishOracle, PL/SQL, Antir, Java, gramatyka, dokumentacja
Keywords in EnglishOracle, PL/SQL, Antlr, Java, grammar, documentation
Abstract in PolishPraca magisterska rozpoczyna się od wprowadzenia do technologii systemu zarządzania bazą danych Oracle oraz charakterystyki języka procedur składowanych PL/SQL wraz z podstawami składni i problemami zwianymi z tworzeniem dokumentacji technicznej kodu. Kolejne rozdziały pracy poświęcone ą opracowanej metodyce dokumentowania kodu oraz aplikacji wspomagającej w automatycznym tworzeniu dokumentacji. W pierwszej kolejności przedstawiony został standard komentarzy dokumentujących. Praca koncentruje się następnie na aspektach zwkanych z analizą kodu PL/SQL w oparciu o formalną gramatykę języka, opisując: gramatykę wykorzystaną w projekcie, zmiany dokonane w niej przez autora, generator analizatorów leksykalnych i składniowych Antlr oraz jego integrację ze stworzoną w ramach pracy magisterskiej aplikacją PLSQLDoxy. Kolejne rozdziały pracy skupiają się na fimkejonahiości związanej z generacją dokumentacji do formatu LaTeX oraz mechanizmie tworzenia dokumentacji jednostek programowych PL/SQL w środowisku aplikacji Enterprise Architect. Pracę kończy podsumowanie osiągniętych celów i przedstawienie perspektyw dalszego rozwoju aplikacji.

Get link to the record

Back