Doxygen 1.8.5

Doxygen - Developers အတွက် Ultimate Documentation Tool

ဆော့ဖ်ဝဲရေးသားသူအနေဖြင့် သင့်ကုဒ်အတွက် ရှင်းလင်းတိကျသော စာရွက်စာတမ်းရှိရန် မည်မျှအရေးကြီးကြောင်း သင်သိပါသည်။ သင့်လျော်သောစာရွက်စာတမ်းမရှိပါက၊ ၎င်းသည် သင်၏ codebase ၏ဖွဲ့စည်းပုံကို နားလည်ရန်ခက်ခဲနိုင်ပြီး ရှုပ်ထွေးမှုများနှင့် အမှားအယွင်းများကိုဖြစ်စေသည်။ Doxygen ဝင်လာသည် - သင်၏အရင်းအမြစ်ဖိုင်များမှ အွန်လိုင်းစာရွက်စာတမ်းများဘရောက်ဆာများနှင့် off-line ကိုးကားချက်လက်စွဲများကို ထုတ်လုပ်နိုင်သည့် အစွမ်းထက်သည့်ကိရိယာတစ်ခုဖြစ်သည်။

Doxygen သည် 1997 ခုနှစ်ကတည်းက အခမဲ့ဖြစ်ပြီး open-source software တစ်ခုဖြစ်သည်။ ၎င်းသည် အသုံးပြုရလွယ်ကူခြင်း၊ ပြောင်းလွယ်ပြင်လွယ်နှင့် အစွမ်းထက်သောလုပ်ဆောင်ချက်များကြောင့် developer များကြားတွင် ရေပန်းအစားဆုံး documentation tool တစ်ခုဖြစ်လာခဲ့သည်။ Doxygen ဖြင့် သင့်ပရောဂျက်များအတွက် ပရော်ဖက်ရှင်နယ်ပုံစံ စာရွက်စာတမ်းများကို သင်ကိုယ်တိုင် နာရီများစွာ မရေးဘဲ အလွယ်တကူ ဖန်တီးနိုင်သည်။

Doxygen ၏ အဓိကအင်္ဂါရပ်များထဲမှတစ်ခုမှာ စာရွက်စာတမ်းများကို သင်၏အရင်းအမြစ်ဖိုင်များမှ တိုက်ရိုက်ထုတ်ယူနိုင်ခြင်းဖြစ်သည်။ ဆိုလိုသည်မှာ သင်သည် သီးခြားစာရွက်စာတမ်းဖိုင်များကို ရေးသားရန် သို့မဟုတ် ၎င်းတို့ကို သင်၏ codebase မှ သီးခြားထိန်းသိမ်းထားရန် မလိုအပ်ပါ။ ယင်းအစား၊ သင်သည် Doxygen အသိအမှတ်ပြုသည့် အထူးတဂ်များကို အသုံးပြု၍ သင်၏အရင်းအမြစ်ဖိုင်များသို့ မှတ်ချက်များထည့်ရုံသာဖြစ်သည်။

ဤတက်ဂ်များသည် သင့်အား လုပ်ဆောင်ချက်များ၊ အတန်းများ၊ ကိန်းရှင်များနှင့် အခြားအရာများကဲ့သို့သော သင့်ကုဒ်၏ ရှုထောင့်အမျိုးမျိုးကို မှတ်တမ်းတင်နိုင်စေပါသည်။ အခြား developer များ (သို့မဟုတ် ကိုယ်တိုင်ပင်) ကုဒ်အလုပ်လုပ်ပုံကို နားလည်ရန် ပိုမိုလွယ်ကူစေသည့် ပါရာမီတာများ၊ ပြန်ပေးတန်ဖိုးများ၊ လုပ်ဆောင်ချက်များ သို့မဟုတ် နည်းလမ်းများဖြင့် ခြွင်းချက်များ စသည်တို့အကြောင်း အချက်အလက်များကိုလည်း သင်ထည့်သွင်းနိုင်သည်။

သင်၏အရင်းအမြစ်ဖိုင်များတစ်လျှောက်တွင် ဤမှတ်ချက်များကို ထည့်သွင်းပြီးသည်နှင့် (အစပိုင်းတွင် ငြီးငွေ့ဖွယ်ထင်ရသော်လည်း spade များတွင် ပေးဆောင်သည်)၊ Doxygen ကိုအသုံးပြုခြင်းသည် function/class/variable/etc အသီးသီးနှင့်သက်ဆိုင်သော အချက်အလက်အားလုံးနှင့်အတူ HTML-based browser interface ကို ထုတ်လုပ်ပေးမည်ဖြစ်သည်။ အမွေဆက်ခံသည့်သစ်ပင်များ သို့မဟုတ် ပူးပေါင်းဆောင်ရွက်ပုံများကဲ့သို့သော ဆက်စပ်ပုံများ အပါအဝင်။

သို့သော် အချို့သောကုဒ်၏ အစိတ်အပိုင်းများကို မှတ်တမ်းမတင်ပါက မည်သို့နည်း။ ပြဿနာမရှိပါဘူး! Doxygen ၏ configuration options (ကျယ်ဝန်းသော) ဖြင့် ထုတ်ပေးထားသော output တွင် မည်သည့်စာရွက်စာတမ်းမပါသော အစိတ်အပိုင်းများ ထည့်သွင်းသင့်သည်ကို သင်ပြောပြနိုင်သည် - ဤနည်းဖြင့် အချို့သောနယ်ပယ်များနှင့်ပတ်သက်သည့် ဗဟုသုတ ကွာဟမှုများရှိနေလျှင်ပင် ၎င်းတို့သည် ကြည့်ရှုသည့်အခါတွင် လုံးဝပျောက်ကွယ်သွားမည်မဟုတ်ပါ။ နောက်ပိုင်းတွင် လိုင်းပေါ်မှ Docs ထုတ်ပေးသည်။

Doxygen ၏ နောက်ထပ်ထူးခြားချက်မှာ RTF (MS-Word)၊ PostScript/PDFs/hyperlinked PDFs/compressed HTML/Unix man စာမျက်နှာများ စသည်တို့ကဲ့သို့သော ဖော်မတ်အမျိုးမျိုးဖြင့် အထွက်ထုတ်ပေးခြင်းကို ပံ့ပိုးပေးပါသည်။ ဆိုလိုသည်မှာ တစ်စုံတစ်ဦးသည် ၎င်းတို့၏ docs များကို မည်ကဲ့သို့ ဖော်မတ်ထားပါစေ၊ ဤနေရာတွင် သင့်လျော်သောအရာကို တွေ့နိုင်ပေလိမ့်မည်။

အစောပိုင်းတွင်ဖော်ပြထားသော ပေါင်းစည်းမှုမှီခိုဂရပ်များသည် အခြားကောင်းမွန်သောအင်္ဂါရပ်များဖြစ်သည်- ဤအရာများသည် ပရောဂျက်တစ်ခုအတွင်း မတူညီသောဒြပ်စင်များ မည်ကဲ့သို့ဆက်စပ်နေပုံကို မြင်သာအောင်ပြသပေးသောကြောင့် အသုံးပြုသူများသည် စာကြောင်းတိုင်းကို ကိုယ်တိုင်ကြိုတင်ဖတ်စရာမလိုဘဲ အရာအားလုံးနှင့်ကိုက်ညီမည့် အကြံဥာဏ်ကို လျင်မြန်စွာရရှိစေပါသည်။ အထူးသဖြင့် အပြန်အလှန်မှီခိုနေသော အစိတ်အပိုင်းများစွာပါရှိသော ပရောဂျက်ကြီးများနှင့် လုပ်ဆောင်သည့်အခါ အထူးသဖြင့် အချိန်ကုန်သက်သာစေသည်။

အမွေဆက်ခံပုံကားချပ်များသည် အတန်း/အင်တာဖေ့စ်များ/စသည်ဖြင့် ဆက်စပ်မှုကိုပြသခြင်းဖြင့် တူညီသောအကျိုးခံစားခွင့်များကို ပေးစွမ်းနိုင်သော်လည်း၊ ပူးပေါင်းမှုပုံစံများသည် တူညီသောအတန်းများ/အင်တာဖေ့စ်များ/စသည်ဖြင့် ကွဲပြားသည့်အရာများကြား အပြန်အလှန်အကျိုးသက်ရောက်မှုများကို ပြသနေပါသည်။ အမျိုးအစားသုံးမျိုးစလုံးသည် မော်ဂျူးများစွာတွင် ပြန့်ကျဲနေသော အကြောင်းအရာပြင်ပအတိုအထွာများကို နားလည်သဘောပေါက်စေရန် ကူညီပေးပါသည်။ /files/folders/etc.

ယေဘူယျအားဖြင့် အရည်အသွေးမြင့် Docs ကို လျင်မြန်ထိရောက်စွာ ထုတ်ပေးနိုင်သော အသုံးပြုရလွယ်ကူသော်လည်း အစွမ်းထက်သည့်ကိရိယာကို ရှာဖွေနေပါက DoxyGen ကို စမ်းသုံးကြည့်ရန် ကျွန်ုပ်တို့ အထူးအကြံပြုလိုပါသည်။