Doxygen 1.8.5

Doksigen - Dasturchilar uchun eng yaxshi hujjatlashtirish vositasi

Ishlab chiquvchi sifatida siz kodingiz uchun aniq va aniq hujjatlarga ega bo'lish qanchalik muhimligini bilasiz. Tegishli hujjatlarsiz kod bazasining tuzilishini tushunish qiyin bo'lishi mumkin, bu chalkashlik va xatolarga olib keladi. Aynan shu erda Doxygen paydo bo'ladi - bu sizning manba fayllaringizdan onlayn hujjat brauzerlari va oflayn ma'lumotnomalarni yaratishi mumkin bo'lgan kuchli vosita.

Doxygen - bu 1997 yildan beri mavjud bo'lgan bepul va ochiq kodli dasturiy ta'minot. U foydalanish qulayligi, moslashuvchanligi va kuchli xususiyatlari tufayli ishlab chiquvchilar orasida eng mashhur hujjatlashtirish vositalaridan biriga aylandi. Doxygen yordamida siz o'zingiz yozish uchun soatlab vaqt sarflamasdan loyihalaringiz uchun professional ko'rinishdagi hujjatlarni osongina yaratishingiz mumkin.

Doxygen-ning asosiy xususiyatlaridan biri bu hujjatlarni to'g'ridan-to'g'ri manba fayllaringizdan olish qobiliyatidir. Bu shuni anglatadiki, siz alohida hujjat fayllarini yozishingiz yoki ularni kod bazasidan alohida saqlashingiz shart emas. Buning o'rniga, siz Doxygen taniydigan maxsus teglar yordamida manba fayllaringizga sharhlar qo'shasiz.

Bu teglar funksiyalar, sinflar, oʻzgaruvchilar va boshqalar kabi kodingizning turli jihatlarini hujjatlashtirish imkonini beradi. Shuningdek, siz boshqa ishlab chiquvchilarga (yoki hatto o'zingizga) kod qanday ishlashini tushunishni osonlashtiradigan parametrlar, qaytariladigan qiymatlar, funktsiyalar yoki usullar tomonidan tashlangan istisnolar va hokazolar haqidagi ma'lumotlarni kiritishingiz mumkin.

Ushbu sharhlarni manba fayllaringizga qo'shganingizdan so'ng (bu birinchi qarashda zerikarli bo'lib tuyulishi mumkin, lekin bir necha baravar to'lanadi), Doxygen-ni ishga tushirish har bir funktsiya/sinf/o'zgaruvchi/va hokazolar haqida barcha tegishli ma'lumotlarni o'z ichiga olgan HTML asosidagi brauzer interfeysini yaratadi. , jumladan, meros daraxtlari yoki hamkorlik diagrammalari kabi bog'liq diagrammalar.

Ammo kodning ba'zi qismlari hujjatlashtirilmagan bo'lsa-chi? Hammasi joyida! Doxygen-ning konfiguratsiya opsiyalari (ular keng) yordamida siz baribir yaratilgan mahsulotga qaysi hujjatsiz qismlar kiritilishi kerakligini ayta olasiz - bu orqali hatto ma'lum sohalar haqidagi bilimlarda bo'shliqlar mavjud bo'lsa ham, ularni ko'rib chiqishda ular butunlay yo'qolib qolmaydi. keyinchalik quyida yaratilgan hujjatlar!

Doxygen-ning yana bir ajoyib xususiyati - bu RTF (MS-Word), PostScript/PDF/giperbog'langan PDF-lar/siqilgan HTML/Unix man-sahifalari kabi turli formatlarda chiqishlarni yaratishni qo'llab-quvvatlashdir. ular bu erda mos keladigan narsani topishlari mumkin!

Yuqorida aytib o'tilgan inklyuziyaga bog'liqlik grafiklari yana bir ajoyib xususiyatdir: ular loyihadagi turli elementlarning vizual tarzda bir-biriga qanday bog'lanishini ko'rsatadi, shuning uchun foydalanuvchilar har bir satrni oldindan o'qib chiqmasdan, hamma narsa joyiga qayerda mos kelishi haqida tezda tasavvurga ega bo'lishadi; Bu, ayniqsa, ko'plab o'zaro bog'liq komponentlarni o'z ichiga olgan yirik loyihalar bilan ishlashda vaqtni tejaydi.

Meros diagrammalari sinflar/interfeyslar/v.k. oʻrtasidagi munosabatlarni koʻrsatish orqali oʻxshash afzalliklarni beradi, hamkorlik diagrammalari esa oʻsha sinflar/interfeyslar/va hokazolar ichidagi turli obʼyektlar oʻrtasidagi oʻzaro taʼsirlarni koʻrsatadi. Uchala tur ham bir nechta modullar boʻylab tarqalgan kontekstdan tashqari parchalarni tushunishga yordam beradi. /fayllar/papkalar/va hokazo.

Umuman olganda, yuqori sifatli hujjatlarni tez va samarali yaratishga qodir, ishlatish uchun oson, ammo kuchli vositani qidirsangiz, DoxyGen-ni sinab ko'rishni tavsiya qilamiz!