Doxygen 1.8.5

Doxygen - վերջնական փաստաթղթավորման գործիք մշակողների համար

Որպես ծրագրավորող՝ դուք գիտեք, թե որքան կարևոր է ձեր կոդի համար ունենալ հստակ և հակիրճ փաստաթղթեր: Առանց համապատասխան փաստաթղթերի, կարող է դժվար լինել հասկանալ ձեր կոդերի բազայի կառուցվածքը, ինչը հանգեցնում է շփոթության և սխալների: Ահա թե որտեղ է հայտնվում Doxygen-ը. հզոր գործիք, որը կարող է ստեղծել առցանց փաստաթղթերի բրաուզերներ և օֆլայն տեղեկատու ձեռնարկներ ձեր աղբյուրի ֆայլերից:

Doxygen-ը անվճար և բաց կոդով ծրագրաշար է, որը գործում է 1997 թվականից: Այն դարձել է ծրագրավորողների շրջանում ամենահայտնի փաստաթղթավորման գործիքներից մեկը՝ շնորհիվ իր հեշտ օգտագործման, ճկունության և հզոր հատկությունների: Doxygen-ի միջոցով դուք հեշտությամբ կարող եք ստեղծել պրոֆեսիոնալ տեսք ունեցող փաստաթղթեր ձեր նախագծերի համար՝ առանց ժամեր ծախսելու՝ դրանք ինքներդ գրելու:

Doxygen-ի հիմնական առանձնահատկություններից մեկն այն է, որ նրա կարողությունն է ուղղակիորեն ձեր աղբյուրի ֆայլերից փաստաթղթեր հանել: Սա նշանակում է, որ դուք պետք չէ գրել առանձին փաստաթղթերի ֆայլեր կամ դրանք պահել ձեր կոդի բազայից առանձին: Փոխարենը, դուք պարզապես մեկնաբանություններ եք ավելացնում ձեր աղբյուրի ֆայլերին՝ օգտագործելով հատուկ պիտակներ, որոնք ճանաչում է Doxygen-ը:

Այս պիտակները թույլ են տալիս փաստաթղթավորել ձեր կոդի տարբեր ասպեկտներ, ինչպիսիք են գործառույթները, դասերը, փոփոխականները և այլն: Կարող եք նաև ներառել տեղեկություններ պարամետրերի, վերադարձի արժեքների, գործառույթների կամ մեթոդների միջոցով գցված բացառությունների մասին և այլն, ինչը հեշտացնում է այլ մշակողների (կամ նույնիսկ ինքներդ ձեզ) հասկանալ, թե ինչպես է աշխատում կոդը:

Երբ դուք ավելացնեք այս մեկնաբանությունները ձեր սկզբնաղբյուր ֆայլերում (որոնք սկզբում կարող են հոգնեցուցիչ թվալ, բայց արդյունք են տալիս), Doxygen-ի գործարկումը կստեղծի HTML-ի վրա հիմնված բրաուզերի ինտերֆեյս՝ յուրաքանչյուր ֆունկցիայի/դասի/փոփոխականի/ և այլնի վերաբերյալ բոլոր համապատասխան տեղեկություններով: , ներառյալ ցանկացած հարակից դիագրամներ, ինչպիսիք են ժառանգական ծառերը կամ համագործակցության դիագրամները:

Բայց ինչ անել, եթե օրենսգրքի որոշ մասեր փաստաթղթավորված չեն: Ոչ մի խնդիր! Doxygen-ի կազմաձևման ընտրանքներով (որոնք ընդարձակ են), դուք կարող եք ասել, թե որ փաստաթղթավորված մասերը, այնուամենայնիվ, պետք է ներառվեն գեներացված ելքում, այս կերպ, նույնիսկ եթե որոշակի ոլորտների վերաբերյալ գիտելիքների բացեր կան, դրանք ամբողջովին չեն բացակայի տեսադաշտից զննարկելիս: ստեղծեց փաստաթղթեր ավելի ուշ:

Doxygen-ի մեկ այլ հիանալի առանձնահատկությունն այն է, որ նա ապահովում է ելք ստեղծելու տարբեր ձևաչափերով, ինչպիսիք են RTF (MS-Word), PostScript/PDFs/hyperlinked PDF/սեղմված HTML/Unix man էջերը և այլն: Սա նշանակում է, որ անկախ նրանից, թե ինչ ձևաչափով ինչ-որ մեկը նախընտրում է իր փաստաթղթերը: նրանք, հավանաբար, այստեղ հարմար բան կգտնեն:

Նախկինում նշված ներառման կախվածության գրաֆիկները ևս մեկ հիանալի հատկանիշ են. դրանք ցույց են տալիս, թե ինչպես են նախագծի տարբեր տարրերը տեսողականորեն փոխկապակցված, որպեսզի օգտվողները արագ պատկերացում կազմեն, թե որտեղ է ամեն ինչ տեղավորվում՝ առանց նախապես առաջին ձեռքից կարդալու յուրաքանչյուր տող: սա խնայում է ժամանակը հատկապես մեծ նախագծերի հետ աշխատելիս, որոնք պարունակում են բազմաթիվ փոխկապակցված բաղադրիչներ:

Ժառանգական դիագրամները տրամադրում են նմանատիպ առավելություններ՝ ցույց տալով դասերի/ինտերֆեյսների/ և այլնի միջև հարաբերությունները, մինչդեռ համագործակցության դիագրամները ցույց են տալիս փոխազդեցությունները տարբեր օբյեկտների միջև այդ նույն դասերի/ինտերֆեյսների/և այլնի միջև: Բոլոր երեք տեսակներն օգնում են իմաստավորել համատեքստից դուրս հատվածները, որոնք ցրված են բազմաթիվ մոդուլներում: /ֆայլեր/թղթապանակներ/ և այլն:

Ընդհանուր առմամբ, մենք խորհուրդ ենք տալիս փորձել DoxyGen-ին, եթե փնտրում եք հեշտ օգտագործման, բայց հզոր գործիք, որը կարող է արագ և արդյունավետ կերպով ստեղծել բարձրորակ փաստաթղթեր: