Onion Information

Page Clicks: 0

First Seen: 03/15/2024

Last Indexed: 09/18/2024

Domain Index Total: 397

Dokumentiranje programskog koda alatom Doxygen - Doxygen je vjerojatno najkorišteniji alat za generiranje dokumentacije iz bilješki u C++ kodu, ali podržava i druge jezike kao što su C, Objective-C, C#, PHP (u praksi se češće koriste phpDocumentor i Doctum ), Java (u praksi se češće koristi Javadoc ), Python (u praksi se češće koristi Docstrings ), Fortran i drugi. Doygen iz komentara izvornog koda može generirati HTML i PDF (korištenjem LaTeX-a ). Osim komentara s dokumentacijom, može u dokumentaciju uključiti i strukturu izvornog koda nedokumentiranih datoteka i proizvoljnu dodatnu dokumentaciju. Primjeri gotove dokumentacije - Neki od projekata koji koriste Doxygen za generiranje dokumentacije aplikacijskog programskog sučelja su: Osnovna konfiguracija - Službena dokumentacija ima mnogo detalja o mogućnostima koji Doxygen ima, a mi ćemo se u nastavku ograničiti na osnovno korištenje. Mi ćemo koristiti naredbu doxygen , a dodatno se može koristiti Doxygenovo grafičko korisničko sučelje (naredba doxywizard ) koje olakšava pojedine korake opisane u nastavku. Za primjer korištenja Doxygena, naredbom - stvorit ćemo datoteku Doxyfile sa zadanom konfiguracijom. U njoj ne moramo mijenjati ništa, samo se uvjerimo se da značka FILE_PATTERNS uključuje *.h - Dokumentiranje koda - U istom direktoriju stvorimo datoteku hello.h s dokumentacijom unutar komentara sadržaja: Uočimo kako Doxygenov blok kreće znakom višeretčanog komentara /* i još jednim dodatnim znakom zvjezdice * . Prvi od blokova je dokumentacija same datoteke koja kreće naredbom \file i imenom datoteke. Zatim imamo krati opis naveden korištenjem naredbe \brief i dugi opis odmaknut od njega za jedan prazni redak. Dokumentacija pojedine funkcije također ima kratak ( \brief ) i dugi opis te navodi što funkcija vraća naredbom \return . Dodajmo u istu datoteku još jednu dokumentiranu funkciju zbroji() oblika: Ovdje vidimo i korištenje naredbi \param kojima navodimo pojedine parametre s njihovim imenima i ulogom. Ukupno je sada kod oblika: Generiranje HTML-a i PDF-a - Pokrenimo generiranje dokumentacije Doxygenom: U direktoriju html dobit ćemo izgrađenu dokumentaciju koju možemo krenuti pregledavati otvaranjem datoteke index.html , a u direktoriju latex dobit ćemo dokumentaciju pisanu u LaTeX-u koju, ako imamo instaliran pdfLaTeX i sve potrebne pakete, možemo izgraditi naredbom make na način: čime ćemo dobiti nekoliko privremenih datoteka ( refman.ind , refman.ilg , refman.toc , refman.out , refman.idx , refman.aux ), rezultirajući PDF ( refman.pdf ) i log datoteku s detaljima prevođenja iz LaTeX-a u PDF ( refman.log ). Zadatak - Deklarirajte klasu PodcastPlayer te metode playEpisode(int episodeId, std::chrono::duration intervalToSkip) , koja započinje emitiranje epizode podcasta s danim rednim brojem i to tako da preskoči dano vrijeme od početka, i stop() , koja zaustavlja emitiranje epizode koja se trenutno emitira. (Metode ne morate implementirati.) Dokumentirajte metode korištenjem Doxygena, a zatim izvedite generiranje dokumentacije. ( Uputa: dokumentiranje klasa vrši se na isti način kao dokumentiranje funkcija, a primjer možete pronaći u dijelu Doxygenove dokumentacije Documenting the code .) - Author: Vedran Miletić