Doxygen 1.8.5

Doxygen - Tərtibatçılar üçün Ən Yaxşı Sənədləşdirmə Aləti

Bir tərtibatçı olaraq kodunuz üçün aydın və qısa sənədlərin olmasının nə qədər vacib olduğunu bilirsiniz. Müvafiq sənədlər olmadan kod bazanızın strukturunu başa düşmək çətin ola bilər ki, bu da çaşqınlıq və səhvlərə səbəb olur. Burada Doxygen gəlir - mənbə fayllarınızdan onlayn sənədləşdirmə brauzerləri və oflayn istinad təlimatları yarada bilən güclü alətdir.

Doxygen 1997-ci ildən mövcud olan pulsuz və açıq mənbəli proqramdır. İstifadə asanlığı, çevikliyi və güclü xüsusiyyətləri sayəsində tərtibatçılar arasında ən populyar sənədləşdirmə vasitələrindən birinə çevrilmişdir. Doxygen ilə siz özünüz yazmağa saatlar sərf etmədən layihələriniz üçün asanlıqla peşəkar görünüşlü sənədlər yarada bilərsiniz.

Doxygen-in əsas xüsusiyyətlərindən biri sənədləri birbaşa mənbə fayllarınızdan çıxarmaq qabiliyyətidir. Bu o deməkdir ki, siz ayrıca sənəd sənədləri yazmağa və ya onları kod bazanızdan ayrı saxlamağa ehtiyac yoxdur. Bunun əvəzinə siz sadəcə olaraq Doxygenin tanıdığı xüsusi etiketlərdən istifadə edərək mənbə fayllarınıza şərhlər əlavə edin.

Bu teqlər kodunuzun funksiyalar, siniflər, dəyişənlər və s. kimi müxtəlif aspektlərini sənədləşdirməyə imkan verir. Siz həmçinin parametrlər, qaytarılan dəyərlər, funksiyalar və ya metodlar tərəfindən atılan istisnalar və s. haqqında məlumatları daxil edə bilərsiniz ki, bu da digər tərtibatçıların (və ya hətta özünüz) kodun necə işlədiyini başa düşməsini asanlaşdırır.

Bu şərhləri mənbə fayllarınıza əlavə etdikdən sonra (ilk baxışda yorucu görünə bilər, lakin öz bəhrəsini verir), Doxygen-in işləməsi hər bir funksiya/sinif/dəyişən/s. miras ağacları və ya əməkdaşlıq diaqramları kimi əlaqəli diaqramlar daxil olmaqla.

Bəs kodun bəzi hissələri sənədləşdirilməsə nə etməli? Problem deyil! Doxygen-in konfiqurasiya seçimləri ilə (genişdir), siz ona hər halda hansı sənədsiz hissələrin yaradılan çıxışa daxil edilməli olduğunu deyə bilərsiniz - beləliklə, müəyyən sahələr haqqında biliklərdə boşluqlar olsa belə, gözdən keçirərkən onlar tamamilə gözdən qaçmayacaq. sonra aşağı-the-line sənədlər yaradılan!

Doxygen-in başqa bir əla xüsusiyyəti RTF (MS-Word), PostScript/PDF-lər/hiperlinkli PDF-lər/sıxılmış HTML/Unix man səhifələri və s. kimi müxtəlif formatlarda çıxış yaratmaq dəstəyidir. Bu o deməkdir ki, kimsə hansı formatda sənədlərə üstünlük verirsə etsin çox güman ki, burada uyğun bir şey tapacaqlar!

Daha əvvəl qeyd olunan daxiletmədən asılılıq qrafikləri başqa bir əla xüsusiyyətdir: bunlar layihə daxilindəki müxtəlif elementlərin vizual olaraq bir-biri ilə necə əlaqəli olduğunu göstərir, beləliklə istifadəçilər əvvəlcədən hər bir sətiri əvvəlcədən oxumadan hər şeyin yerinə uyğun olduğu barədə fikir əldə edirlər; Bu, xüsusən də bir-birindən asılı çoxlu komponentləri olan böyük layihələrlə işləyərkən vaxta qənaət edir.

Varislik diaqramları siniflər/interfeyslər/s. arasında əlaqələri göstərməklə oxşar faydalar təmin edir, əməkdaşlıq diaqramları isə həmin siniflər/interfeyslər/s. daxilində müxtəlif obyektlər arasında qarşılıqlı əlaqəni göstərir. Hər üç növ bir çox modullara səpələnmiş kontekstdən kənar fraqmentləri anlamağa kömək edir. /fayllar/qovluqlar/s..

Ümumiyyətlə, yüksək keyfiyyətli sənədləri tez və səmərəli şəkildə yarada bilən istifadəsi asan, lakin güclü alət axtarırsınızsa, DoxyGen-i sınamağı çox tövsiyə edirik!