Doxygen 1.8.5

Doxygen - L-Għodda ta' Dokumentazzjoni Ultimate għall-Iżviluppaturi

Bħala żviluppatur, taf kemm huwa importanti li jkollok dokumentazzjoni ċara u konċiża għall-kodiċi tiegħek. Mingħajr dokumentazzjoni xierqa, jista 'jkun diffiċli li tifhem l-istruttura tal-codebase tiegħek, li twassal għal konfużjoni u żbalji. Hemmhekk jidħol Doxygen - għodda qawwija li tista' tiġġenera brawżers ta' dokumentazzjoni onlajn u manwali ta' referenza off-line mill-fajls tas-sors tiegħek.

Doxygen huwa softwer b'xejn u b'sors miftuħ li ilu madwar sa mill-1997. Sar wieħed mill-aktar għodod ta 'dokumentazzjoni popolari fost l-iżviluppaturi minħabba l-faċilità ta' użu, il-flessibbiltà u l-karatteristiċi qawwija tiegħu. B'Doxygen, tista' faċilment toħloq dokumentazzjoni ta' dehra professjonali għall-proġetti tiegħek mingħajr ma tqatta' sigħat tiktebha lilek innifsek.

Waħda mill-karatteristiċi ewlenin ta 'Doxygen hija l-abbiltà tiegħu li jiġbed id-dokumentazzjoni direttament mill-fajls tas-sors tiegħek. Dan ifisser li m'għandekx għalfejn tikteb fajls ta' dokumentazzjoni separati jew iżżommhom separatament mill-codebase tiegħek. Minflok, sempliċement iżżid kummenti mal-fajls tas-sors tiegħek billi tuża tikketti speċjali li Doxygen jirrikonoxxi.

Dawn it-tikketti jippermettulek tiddokumenta diversi aspetti tal-kodiċi tiegħek bħal funzjonijiet, klassijiet, varjabbli, u aktar. Tista 'wkoll tinkludi informazzjoni dwar parametri, valuri ta' ritorn, eċċezzjonijiet mitfugħa minn funzjonijiet jew metodi eċċ., Li tagħmilha aktar faċli għal żviluppaturi oħra (jew saħansitra lilek innifsek) biex jifhmu kif jaħdem il-kodiċi.

Ladarba tkun żidt dawn il-kummenti matul il-fajls tas-sors tiegħek (li jistgħu jidhru tedious għall-ewwel iżda jħallsu frott), it-tħaddim ta 'Doxygen se jiġġenera interface tal-browser ibbażat fuq HTML bl-informazzjoni kollha rilevanti dwar kull funzjoni/klassi/varjabbli/eċċ. , inkluż kwalunkwe dijagramma assoċjata bħal siġar tal-wirt jew dijagrammi ta' kollaborazzjoni.

Imma x'jiġri jekk xi partijiet tal-kodiċi mhumiex dokumentati? Mhux problema! Bl-għażliet ta 'konfigurazzjoni ta' Doxygen (li huma estensivi), tista 'tgħidilha liema partijiet mhux dokumentati għandhom jiġu inklużi fl-output iġġenerat xorta waħda - b'dan il-mod anki jekk ikun hemm lakuni fl-għarfien dwar ċerti oqsma mhux se jkunu kompletament neqsin mill-vista meta tibbrawżja. iġġenerat docs aktar tard down-the-line!

Fattur ieħor kbir ta’ Doxygen huwa l-appoġġ tiegħu biex jiġġenera output f’diversi formati bħal RTF (MS-Word), PostScript/PDFs/PDFs hyperlinked/HTML kompressat/paġni man Unix eċċ. fil dawn x'aktarx isibu xi ħaġa xierqa hawn!

Il-grafiċi tad-dipendenza tal-inklużjoni msemmija qabel huma karatteristika kbira oħra: dawn juru kif elementi differenti fi ħdan proġett jirrelataw flimkien viżwalment sabiex l-utenti jieħdu idea malajr fejn kollox jidħol f'posthom mingħajr ma jkunu qraw kull linja huma stess minn qabel; dan jiffranka l-ħin speċjalment meta taħdem ma 'proġetti kbar li jkun fihom ħafna komponenti interdipendenti.

Id-dijagrammi tal-wirt jipprovdu benefiċċji simili billi juru relazzjonijiet bejn klassijiet/interfaces/eċċ., filwaqt li dijagrammi ta’ kollaborazzjoni juru interazzjonijiet bejn oġġetti differenti fi ħdan dawk l-istess klassijiet/interfaces/eċċ. /files/folders/eċċ..

B'mod ġenerali allura nirrakkomandaw ħafna li tipprova DoxyGen jekk tfittex għodda faċli biex tużah iżda b'saħħitha li kapaċi tiġġenera doks ta' kwalità għolja malajr u b'mod effiċjenti!