Doxygen 1.8.5

Doxygen - Mjeti përfundimtar i dokumentacionit për zhvilluesit

Si zhvillues, ju e dini se sa e rëndësishme është të keni dokumentacion të qartë dhe konciz për kodin tuaj. Pa dokumentacionin e duhur, mund të jetë e vështirë të kuptosh strukturën e bazës së kodit, duke çuar në konfuzion dhe gabime. Këtu hyn Doxygen - një mjet i fuqishëm që mund të gjenerojë shfletues dokumentacioni në linjë dhe manuale referimi jashtë linje nga skedarët tuaj burimor.

Doxygen është një softuer falas dhe me burim të hapur që ekziston që nga viti 1997. Ai është bërë një nga mjetet më të njohura të dokumentacionit midis zhvilluesve për shkak të lehtësisë së përdorimit, fleksibilitetit dhe veçorive të fuqishme. Me Doxygen, ju mund të krijoni lehtësisht dokumentacion me pamje profesionale për projektet tuaja pa shpenzuar orë të tëra duke e shkruar vetë.

Një nga veçoritë kryesore të Doxygen është aftësia e tij për të nxjerrë dokumentacionin direkt nga skedarët tuaj burimor. Kjo do të thotë që ju nuk keni nevojë të shkruani skedarë të veçantë dokumentacioni ose t'i mbani ato veçmas nga baza juaj e kodit. Në vend të kësaj, ju thjesht shtoni komente në skedarët tuaj burimor duke përdorur etiketa speciale që Doxygen njeh.

Këto etiketa ju lejojnë të dokumentoni aspekte të ndryshme të kodit tuaj si funksionet, klasat, variablat dhe më shumë. Ju gjithashtu mund të përfshini informacione për parametrat, vlerat e kthyera, përjashtimet e hedhura nga funksionet ose metodat etj., duke e bërë më të lehtë për zhvilluesit e tjerë (ose edhe veten) të kuptojnë se si funksionon kodi.

Pasi t'i keni shtuar këto komente nëpër skedarët tuaj burimor (që mund të duken të lodhshme në fillim, por shpërblehen me lopata), ekzekutimi i Doxygen do të gjenerojë një ndërfaqe shfletuesi të bazuar në HTML me të gjithë informacionin përkatës për çdo funksion/klasë/ndryshore/etj. , duke përfshirë çdo diagram të lidhur si pemët e trashëgimisë ose diagramet e bashkëpunimit.

Por, çka nëse disa pjesë të kodit nuk janë të dokumentuara? Nuk ka problem! Me opsionet e konfigurimit të Doxygen (të cilat janë të gjera), ju mund t'i tregoni se cilat pjesë të padokumentuara duhet të përfshihen në daljen e gjeneruar gjithsesi - në këtë mënyrë edhe nëse ka boshllëqe në njohuritë për zona të caktuara, ato nuk do të mungojnë plotësisht nga pamja gjatë shfletimit. Dokumentet e gjeneruara më vonë në linjë!

Një veçori tjetër e shkëlqyeshme e Doxygen është mbështetja e tij për gjenerimin e rezultateve në formate të ndryshme si RTF (MS-Word), PostScript/PDF/PDF me hiperlink/faqe të ngjeshur HTML/Unix, etj.. Kjo do të thotë se pavarësisht se çfarë formati dikush preferon dokumentet e tij me siguri do të gjejnë diçka të përshtatshme këtu!

Grafikët e varësisë së përfshirjes të përmendur më parë janë një tjetër veçori e shkëlqyer: këto tregojnë se si elementë të ndryshëm brenda një projekti lidhen vizualisht, në mënyrë që përdoruesit të marrin shpejt një ide se ku çdo gjë përshtatet në vend, pa e lexuar vetë çdo rresht paraprakisht; kjo kursen kohë veçanërisht kur punoni me projekte të mëdha që përmbajnë shumë komponentë të ndërvarur.

Diagramet e trashëgimisë ofrojnë përfitime të ngjashme duke treguar marrëdhëniet midis klasave/ndërfaqeve/etj., ndërsa diagramet e bashkëpunimit tregojnë ndërveprimet ndërmjet objekteve të ndryshme brenda të njëjtave klasa/ndërfaqe/etj. Të tre llojet ndihmojnë në kuptimin e fragmenteve jashtë kontekstit të shpërndara nëpër module të shumta /skedarët/dosjet/etj..

Në përgjithësi, atëherë ne rekomandojmë shumë që të provoni DoxyGen nëse kërkoni një mjet të lehtë për t'u përdorur, por të fuqishëm, i aftë për të gjeneruar dokumente me cilësi të lartë shpejt dhe me efikasitet!