Doxygen 1.8.5

Doxygen - әзірлеушілерге арналған соңғы құжаттама құралы

Әзірлеуші ​​ретінде сіз кодыңыз үшін нақты және қысқа құжаттаманың болуы қаншалықты маңызды екенін білесіз. Тиісті құжаттамасыз кодтық базаның құрылымын түсіну қиын болуы мүмкін, бұл шатасуға және қателерге әкеледі. Дәл осы жерде Doxygen кіреді - бастапқы файлдардан онлайн құжаттама браузерлері мен желіден тыс анықтамалық нұсқаулықтарды жасай алатын қуатты құрал.

Doxygen – 1997 жылдан бері жұмыс істеп келе жатқан тегін және бастапқы көзі ашық бағдарламалық құрал. Ол пайдаланудың қарапайымдылығы, икемділігі және қуатты мүмкіндіктері арқасында әзірлеушілер арасында ең танымал құжаттама құралдарының біріне айналды. Doxygen көмегімен сіз өзіңіз жазуға бірнеше сағат жұмсамай, жобаларыңыз үшін кәсіби көрінетін құжаттаманы оңай жасай аласыз.

Doxygen негізгі мүмкіндіктерінің бірі құжаттаманы бастапқы файлдардан тікелей шығару мүмкіндігі болып табылады. Бұл бөлек құжаттама файлдарын жазудың немесе оларды код базасынан бөлек ұстаудың қажеті жоқ дегенді білдіреді. Оның орнына сіз Doxygen танитын арнайы тегтерді пайдаланып бастапқы файлдарға түсініктемелерді қосасыз.

Бұл тегтер функциялар, сыныптар, айнымалылар және т.б. сияқты кодтың әртүрлі аспектілерін құжаттауға мүмкіндік береді. Сондай-ақ, басқа әзірлеушілерге (немесе өзіңізге) кодтың қалай жұмыс істейтінін түсінуді жеңілдететін параметрлер, қайтарылатын мәндер, функциялар немесе әдістер арқылы шығарылған ерекшеліктер және т.б. туралы ақпаратты қосуға болады.

Бұл түсініктемелерді бастапқы файлдарға қосқаннан кейін (алғашында жалықтыратын болып көрінуі мүмкін, бірақ бірнеше рет төлейді), Doxygen іске қосу әрбір функция/сынып/айнымалы/т.б. туралы барлық тиісті ақпараты бар HTML негізіндегі браузер интерфейсін жасайды. , соның ішінде мұра ағаштары немесе бірлескен диаграммалар сияқты кез келген байланысты диаграммалар.

Бірақ егер кодтың кейбір бөліктері құжатталмаған болса ше? Проблема жоқ! Doxygen конфигурациясының опцияларымен (олар ауқымды), сіз қандай құжатталмаған бөліктерді генерацияланған шығысқа қосу керектігін айта аласыз - осылайша белгілі бір аймақтар туралы білімде олқылықтар болса да, шолу кезінде олар толығымен жоғалып кетпейді. кейінірек төменде жасалған құжаттар!

Doxygen бағдарламасының тағы бір тамаша ерекшелігі - оның RTF (MS-Word), PostScript/PDF файлдары/гиперсілтемелері бар PDF файлдары/сығылған HTML/Unix пайдаланушы беттері және т.б. сияқты әртүрлі пішімдерде шығыс шығаруға қолдауы. олар осы жерден қолайлы нәрсені табуы мүмкін!

Жоғарыда айтылған қосуға тәуелділік графиктері тағы бір тамаша мүмкіндік болып табылады: олар жобадағы әртүрлі элементтердің бір-бірімен визуалды түрде қалай байланысатынын көрсетеді, осылайша пайдаланушылар әрбір жолды алдын ала оқымай-ақ, бәрі орнына келетіні туралы тез түсінік алады; бұл әсіресе көптеген өзара тәуелді компоненттері бар үлкен жобалармен жұмыс істегенде уақытты үнемдейді.

Мұрагерлік диаграммалар сыныптар/интерфейстер/т.б. арасындағы қарым-қатынастарды көрсету арқылы ұқсас артықшылықтарды қамтамасыз етеді, ал бірлесіп жұмыс істеу диаграммалары сол сыныптар/интерфейстер/т.б. ішіндегі әртүрлі нысандар арасындағы өзара әрекеттесуді көрсетеді. Барлық үш түрдің барлығы бірнеше модульге шашыраңқы контекстен тыс үзінділерді түсінуге көмектеседі. /файлдар/қалталар/т.б.

Тұтастай алғанда, жоғары сапалы құжаттарды жылдам және тиімді жасай алатын, пайдалану оңай, бірақ қуатты құралды іздесеңіз, DoxyGen-ді сынап көруді ұсынамыз!