Doxygen 1.8.5

Doxygen - hið fullkomna skjalatól fyrir hönnuði

Sem verktaki veistu hversu mikilvægt það er að hafa skýr og hnitmiðuð skjöl fyrir kóðann þinn. Án viðeigandi gagna getur verið erfitt að skilja uppbyggingu kóðagrunnsins, sem leiðir til ruglings og villna. Það er þar sem Doxygen kemur inn - öflugt tól sem getur búið til skjalavafra á netinu og tilvísunarhandbækur utan nets úr frumskránum þínum.

Doxygen er ókeypis og opinn hugbúnaður sem hefur verið til síðan 1997. Hann er orðinn eitt vinsælasta skjalatólið meðal þróunaraðila vegna auðveldrar notkunar, sveigjanleika og öflugra eiginleika. Með Doxygen geturðu auðveldlega búið til faglega útlit skjöl fyrir verkefnin þín án þess að eyða tíma í að skrifa það sjálfur.

Einn af lykileiginleikum Doxygen er hæfni þess til að vinna skjöl beint úr frumskránum þínum. Þetta þýðir að þú þarft ekki að skrifa aðskildar skjalaskrár eða viðhalda þeim aðskilið frá kóðagrunninum þínum. Þess í stað bætirðu einfaldlega athugasemdum við frumskrárnar þínar með því að nota sérstök merki sem Doxygen þekkir.

Þessi merki gera þér kleift að skrá ýmsa þætti kóðans þíns eins og aðgerðir, flokka, breytur og fleira. Þú getur líka látið upplýsingar um færibreytur, skilgildi, undantekningar frá aðgerðum eða aðferðum o.s.frv., sem gerir það auðveldara fyrir aðra forritara (eða jafnvel sjálfan þig) að skilja hvernig kóðinn virkar.

Þegar þú hefur bætt þessum athugasemdum við í gegnum frumskrárnar þínar (sem kann að virðast leiðinlegt í fyrstu en skilar sér í spaða), mun keyra Doxygen búa til HTML-undirstaða vafraviðmót með öllum viðeigandi upplýsingum um hverja aðgerð/flokk/breytu/o.s.frv. , þar á meðal allar tengdar skýringarmyndir eins og erfðatré eða samstarfsmyndir.

En hvað ef sumir hlutar kóðans eru ekki skjalfestir? Ekkert mál! Með stillingarvalkostum Doxygen (sem eru umfangsmiklir) geturðu sagt hvaða óskráðu hlutar ættu að vera með í framleiddu úttakinu samt sem áður - á þennan hátt, jafnvel þó að það sé gjá í þekkingu um ákveðin svæði, þá vantar þau ekki alveg þegar þú vafrar í gegnum búin til skjöl seinna á línunni!

Annar frábær eiginleiki Doxygen er stuðningur þess við að búa til úttak á ýmsum sniðum eins og RTF (MS-Word), PostScript/PDF/hyperlinked PDFs/compressed HTML/Unix man pages o.s.frv.. Þetta þýðir að sama hvaða sniði einhver kýs skjölin sín. inn munu þeir líklega finna eitthvað við hæfi hér!

Gröfin fyrir ósjálfstæði fyrir þátttöku sem nefnd voru áðan eru annar frábær eiginleiki: þessi sýna hvernig mismunandi þættir innan verkefnis tengjast sjónrænt saman þannig að notendur fái fljótt hugmynd um hvar allt passar á sinn stað án þess að hafa lesið í gegnum hverja línu sjálfir fyrirfram; þetta sparar tíma sérstaklega þegar unnið er með stór verkefni sem innihalda marga innbyrðis háða þætti.

Erfðamyndir veita svipaðan ávinning með því að sýna tengsl milli flokka/viðmóta/o.s.frv., á meðan samvinnuskýringarmyndir sýna samskipti milli mismunandi hluta innan sömu flokka/viðmóta/oss. /files/folders/etc..

Á heildina litið mælum við eindregið með því að prófa DoxyGen ef þú ert að leita að auðveldu en samt öflugu tæki sem getur búið til hágæða skjöl á fljótlegan og skilvirkan hátt!