Doxygen 1.8.5

Doxygen – didžiausias dokumentacijos įrankis kūrėjams

Kaip kūrėjas žinote, kaip svarbu turėti aiškią ir glaustą kodo dokumentaciją. Be tinkamų dokumentų gali būti sunku suprasti kodų bazės struktūrą, o tai gali sukelti painiavą ir klaidų. Štai čia ir atsiranda Doxygen – galingas įrankis, galintis generuoti internetines dokumentacijos naršykles ir neprisijungus nuorodų vadovus iš jūsų šaltinio failų.

Doxygen yra nemokama atvirojo kodo programinė įranga, sukurta nuo 1997 m. Ji tapo vienu populiariausių dokumentacijos įrankių tarp kūrėjų dėl savo naudojimo paprastumo, lankstumo ir galingų funkcijų. Naudodami Doxygen galite lengvai sukurti profesionaliai atrodančią savo projektų dokumentaciją, negaišdami valandų jas rašydami patys.

Viena iš pagrindinių „Doxygen“ savybių yra galimybė išgauti dokumentus tiesiai iš šaltinio failų. Tai reiškia, kad jums nereikia rašyti atskirų dokumentacijos failų arba tvarkyti jų atskirai nuo kodų bazės. Vietoj to, tiesiog pridėkite komentarų prie šaltinio failų naudodami specialias žymas, kurias atpažįsta Doxygen.

Šios žymos leidžia dokumentuoti įvairius kodo aspektus, pvz., funkcijas, klases, kintamuosius ir kt. Taip pat galite įtraukti informaciją apie parametrus, grąžinimo reikšmes, funkcijų ar metodų išskirtas išimtis ir pan., kad kitiems kūrėjams (ar net jums pačiam) būtų lengviau suprasti, kaip veikia kodas.

Kai pridėsite šiuos komentarus į savo šaltinio failus (tai iš pradžių gali atrodyti varginantys, bet pasiteisina), paleidus Doxygen bus sukurta HTML pagrindu sukurta naršyklės sąsaja su visa reikiama informacija apie kiekvieną funkciją/klasę/kintamąjį/tt. , įskaitant visas susijusias diagramas, pvz., paveldėjimo medžius arba bendradarbiavimo diagramas.

Bet ką daryti, jei kai kurios kodo dalys nėra dokumentuotos? Jokiu problemu! Naudodami „Doxygen“ konfigūravimo parinktis (kurios yra plačios), galite nustatyti, kurios nedokumentuotos dalys vis tiek turėtų būti įtrauktos į generuojamą išvestį – tokiu būdu net jei yra žinių apie tam tikras sritis spragų, jų visiškai netrūks naršant. sugeneruotus dokumentus vėliau!

Dar viena puiki „Doxygen“ savybė yra palaikymas generuojant išvestį įvairiais formatais, tokiais kaip RTF (MS-Word), PostScript/PDF/hipersaitais PDF/suspausti HTML/Unix man puslapiai ir tt. Tai reiškia, kad nesvarbu, kokiam formatui kas nors teikia pirmenybę savo dokumentams greičiausiai jie čia ras ką nors tinkamo!

Anksčiau paminėtos įtraukimo priklausomybės diagramos yra dar viena puiki savybė: jos parodo, kaip skirtingi projekto elementai yra tarpusavyje susiję vizualiai, todėl vartotojai greitai suvokia, kur viskas telpa į vietą, prieš tai neperskaitę kiekvienos eilutės; tai ypač taupo laiką dirbant su dideliais projektais, kuriuose yra daug tarpusavyje susijusių komponentų.

Paveldėjimo diagramos suteikia panašią naudą, rodydamos ryšius tarp klasių/sąsajų/tt, o bendradarbiavimo diagramos rodo sąveiką tarp skirtingų objektų tose pačiose klasėse/sąsajose/tt. Visi trys tipai padeda suprasti ne konteksto fragmentus, išsibarsčiusius keliuose moduliuose. /files/folders/etc..

Apskritai, labai rekomenduojame išbandyti DoxyGen, jei ieškote lengvai naudojamo, bet galingo įrankio, galinčio greitai ir efektyviai generuoti aukštos kokybės dokumentus!