Doxygen 1.8.5

Doxygen - Den Ultimate Dokumentatiounsinstrument fir Entwéckler

Als Entwéckler wësst Dir wéi wichteg et ass kloer a präzis Dokumentatioun fir Äre Code ze hunn. Ouni richteg Dokumentatioun kann et schwéier sinn d'Struktur vun Ärer Codebase ze verstoen, wat zu Duercherneen a Feeler féiert. Dat ass wou Doxygen erakënnt - e mächtegt Tool dat online Dokumentatiounsbrowser an Off-line Referenzmanualen aus Äre Quelldateien generéiere kann.

Doxygen ass eng gratis an Open Source Software déi zënter 1997 existéiert. Et ass ee vun de populäersten Dokumentatiounsinstrumenter ënner Entwéckler ginn wéinst senger einfacher Benotzung, Flexibilitéit a mächtege Features. Mat Doxygen kënnt Dir einfach eng professionell ausgesinn Dokumentatioun fir Är Projeten erstellen ouni Stonnen ze verbréngen et selwer ze schreiwen.

Ee vun de Schlësselmerkmale vum Doxygen ass seng Fäegkeet fir Dokumentatioun direkt vun Äre Quelldateien ze extrahieren. Dëst bedeit datt Dir keng separat Dokumentatiounsdateien schreiwen oder se separat vun Ärer Codebase ënnerhalen. Amplaz füügt Dir einfach Kommentaren op Är Quelldateien mat speziellen Tags un, déi Doxygen erkennt.

Dës Tags erlaben Iech verschidden Aspekter vun Ärem Code ze dokumentéieren wéi Funktiounen, Klassen, Variablen, a méi. Dir kënnt och Informatioun iwwer Parameteren enthalen, Retourwäerter, Ausnahmen, déi vu Funktiounen oder Methoden geworf ginn, etc., wat et méi einfach mécht fir aner Entwéckler (oder souguer Iech selwer) ze verstoen wéi de Code funktionnéiert.

Wann Dir dës Kommentarer an Äre Quelldateien bäigefüügt hutt (wat am Ufank langweileg schéngen kann, awer a Spades bezilt), wäert d'Doxygen eng HTML-baséiert Browser-Interface generéieren mat all relevant Informatioun iwwer all Funktioun/Klass/Variabel/etc. , dorënner all assoziéiert Diagrammer wéi Ierfbeem oder Zesummenaarbecht Diagrammer.

Awer wat wann e puer Deeler vum Code net dokumentéiert sinn? Kee Problem! Mat dem Doxygen seng Konfiguratiounsméiglechkeeten (déi extensiv sinn), kënnt Dir et soen wéi eng ondokumentéiert Deeler souwisou an der generéierter Ausgab solle mat abegraff sinn - sou och wann et Lücken am Wëssen iwwer bestëmmte Beräicher sinn, wäerte se net komplett aus der Sicht fehlen wann Dir duerchsicht. generéiert Dokumenter méi spéit op der Linn!

Eng aner super Feature vum Doxygen ass seng Ënnerstëtzung fir Output a verschiddene Formater ze generéieren wéi RTF (MS-Word), PostScript/PDFs/Hyperlinked PDFs/kompriméiert HTML/Unix Man Pages etc. an si fannen hei wahrscheinlech eppes passend!

D'Inklusioun Ofhängegkeet Grafiken virdrun ernimmt sinn eng aner flott Fonktioun: dës weisen wéi verschidden Elementer bannent engem Projet Zesummenhang visuell zesummen sou Benotzer séier eng Iddi kréien wou alles an Plaz passt ouni duerch all Zeil selwer éischt Hand liesen Virdrun; dëst spuert Zäit besonnesch wann Dir mat grousse Projete schafft, déi vill interdependent Komponenten enthalen.

Ierfschaftsdiagrammer bidden ähnlech Virdeeler andeems se Relatiounen tëscht Klassen/Interfaces/etc. weisen, wärend Zesummenaarbecht Diagrammer Interaktiounen tëscht verschiddenen Objeten an deene selwechte Klassen/Interfaces/asw weisen. /files/folders/etc..

Insgesamt empfeelen mir DoxyGen e Versuch wann Dir no engem einfach ze benotzen awer mächtege Tool sicht dat fäeg ass héichqualitativ Dokumenter séier an effizient ze generéieren!