Doxygen 1.8.5

Doxygen — labākais dokumentācijas rīks izstrādātājiem

Kā izstrādātājs jūs zināt, cik svarīgi ir, lai jūsu kodam būtu skaidra un kodolīga dokumentācija. Bez atbilstošas ​​dokumentācijas var būt grūti saprast jūsu kodu bāzes struktūru, kas var radīt neskaidrības un kļūdas. Šeit parādās Doxygen — jaudīgs rīks, kas var ģenerēt tiešsaistes dokumentācijas pārlūkprogrammas un bezsaistes uzziņu rokasgrāmatas no jūsu avota failiem.

Doxygen ir bezmaksas un atvērtā koda programmatūra, kas ir pieejama kopš 1997. gada. Tā ir kļuvusi par vienu no populārākajiem dokumentācijas rīkiem izstrādātāju vidū, pateicoties tās lietošanas vienkāršībai, elastībai un jaudīgajiem līdzekļiem. Izmantojot Doxygen, varat viegli izveidot profesionāla izskata dokumentāciju saviem projektiem, netērējot stundas pašam to rakstīšanai.

Viena no galvenajām Doxygen iezīmēm ir tā spēja izvilkt dokumentāciju tieši no jūsu avota failiem. Tas nozīmē, ka jums nav jāraksta atsevišķi dokumentācijas faili vai tie jāuztur atsevišķi no kodu bāzes. Tā vietā jūs vienkārši pievienojiet komentārus saviem avota failiem, izmantojot īpašus tagus, ko Doxygen atpazīst.

Šie tagi ļauj dokumentēt dažādus koda aspektus, piemēram, funkcijas, klases, mainīgos un citus. Varat arī iekļaut informāciju par parametriem, atgriešanas vērtībām, funkciju vai metožu radītiem izņēmumiem utt., lai citiem izstrādātājiem (vai pat jums) būtu vieglāk saprast, kā kods darbojas.

Kad esat pievienojis šos komentārus savos avota failos (kas sākumā var šķist nogurdinoši, bet atmaksājas), palaižot Doxygen, tiks ģenerēts uz HTML balstīts pārlūkprogrammas interfeiss ar visu atbilstošo informāciju par katru funkciju/klasi/mainīgo/u.c. , tostarp visas saistītās diagrammas, piemēram, mantojuma koki vai sadarbības diagrammas.

Bet ko darīt, ja dažas koda daļas nav dokumentētas? Nekādu problēmu! Izmantojot Doxygen konfigurācijas opcijas (kas ir plašas), varat noteikt, kuras nedokumentētās daļas jebkurā gadījumā ir jāiekļauj ģenerētajā izvadē - tādā veidā pat tad, ja ir nepilnības zināšanās par noteiktām jomām, pārlūkošanas laikā tās pilnībā nepazudīs. ģenerētos dokumentus vēlāk!

Vēl viena lieliska Doxygen īpašība ir tās atbalsts izvades ģenerēšanai dažādos formātos, piemēram, RTF (MS-Word), PostScript/PDF/hipersaišu PDF/saspiestā HTML/Unix man lappusēs utt. Tas nozīmē, ka neatkarīgi no formāta kāds dod priekšroku saviem dokumentiem viņi, iespējams, šeit atradīs kaut ko piemērotu!

Iepriekš minētie iekļaušanas atkarības grafiki ir vēl viena lieliska iezīme: tie parāda, kā dažādi projekta elementi ir vizuāli saistīti, lai lietotāji ātri saprastu, kur viss iederas vietā, iepriekš neizlasot katru rindiņu; tas ietaupa laiku, īpaši strādājot ar lieliem projektiem, kuros ir daudz savstarpēji atkarīgu komponentu.

Mantojuma diagrammas sniedz līdzīgas priekšrocības, parādot attiecības starp klasēm/saskarnēm/u.c., savukārt sadarbības diagrammas parāda mijiedarbību starp dažādiem objektiem tajās pašās klasēs/saskarnēs/utt. Visi trīs veidi palīdz izprast ārpus konteksta fragmentus, kas izkaisīti pa vairākiem moduļiem. /files/folders/etc..

Kopumā mēs ļoti iesakām izmēģināt DoxyGen, ja meklējat viegli lietojamu, bet jaudīgu rīku, kas spēj ātri un efektīvi ģenerēt augstas kvalitātes dokumentus!