Doxygen 1.8.5

Doxygen - ឧបករណ៍ឯកសារចុងក្រោយសម្រាប់អ្នកអភិវឌ្ឍន៍

ក្នុងនាមជាអ្នកអភិវឌ្ឍន៍ អ្នកដឹងពីសារៈសំខាន់នៃការមានឯកសារច្បាស់លាស់ និងសង្ខេបសម្រាប់កូដរបស់អ្នក។ បើគ្មានឯកសារត្រឹមត្រូវ វាអាចពិបាកយល់អំពីរចនាសម្ព័ន្ធនៃមូលដ្ឋានកូដរបស់អ្នក ដែលនាំឱ្យមានការភ័ន្តច្រឡំ និងកំហុស។ នោះហើយជាកន្លែងដែល Doxygen ចូលមក - ឧបករណ៍ដ៏មានអានុភាពដែលអាចបង្កើតកម្មវិធីរុករកឯកសារតាមអ៊ីនធឺណិត និងសៀវភៅណែនាំឯកសារយោងក្រៅបណ្តាញពីឯកសារប្រភពរបស់អ្នក។

Doxygen គឺជាកម្មវិធីឥតគិតថ្លៃ និងប្រភពបើកចំហដែលមានតាំងពីឆ្នាំ 1997 ។ វាបានក្លាយជាឧបករណ៍ឯកសារដ៏ពេញនិយមបំផុតក្នុងចំណោមអ្នកអភិវឌ្ឍន៍ ដោយសារភាពងាយស្រួលនៃការប្រើប្រាស់ ភាពបត់បែន និងមុខងារដ៏មានឥទ្ធិពល។ ជាមួយនឹង Doxygen អ្នកអាចបង្កើតឯកសារដែលមានជំនាញវិជ្ជាជីវៈយ៉ាងងាយស្រួលសម្រាប់គម្រោងរបស់អ្នកដោយមិនចាំបាច់ចំណាយពេលរាប់ម៉ោងក្នុងការសរសេរវាដោយខ្លួនឯង។

លក្ខណៈសំខាន់មួយនៃ Doxygen គឺសមត្ថភាពរបស់វាក្នុងការទាញយកឯកសារដោយផ្ទាល់ពីឯកសារប្រភពរបស់អ្នក។ នេះមានន័យថា អ្នកមិនចាំបាច់សរសេរឯកសារឯកសារដាច់ដោយឡែក ឬរក្សាទុកវាដាច់ដោយឡែកពីមូលដ្ឋានកូដរបស់អ្នកទេ។ ផ្ទុយទៅវិញ អ្នកគ្រាន់តែបន្ថែមមតិយោបល់ទៅឯកសារប្រភពរបស់អ្នកដោយប្រើស្លាកពិសេសដែល Doxygen ទទួលស្គាល់។

ស្លាកទាំងនេះអនុញ្ញាតឱ្យអ្នកកត់ត្រាទិដ្ឋភាពផ្សេងៗនៃកូដរបស់អ្នកដូចជា មុខងារ ថ្នាក់ អថេរ និងច្រើនទៀត។ អ្នកក៏អាចរួមបញ្ចូលព័ត៌មានអំពីប៉ារ៉ាម៉ែត្រ តម្លៃត្រឡប់ ការលើកលែងដែលបោះចោលដោយមុខងារ ឬវិធីសាស្ត្រជាដើម ដែលធ្វើឱ្យវាកាន់តែងាយស្រួលសម្រាប់អ្នកអភិវឌ្ឍន៍ផ្សេងទៀត (ឬសូម្បីតែខ្លួនអ្នក) ដើម្បីយល់ពីរបៀបដែលកូដដំណើរការ។

នៅពេលដែលអ្នកបានបន្ថែមមតិយោបល់ទាំងនេះនៅទូទាំងឯកសារប្រភពរបស់អ្នក (ដែលមើលទៅហាក់ដូចជាធុញទ្រាន់នៅពេលដំបូង ប៉ុន្តែត្រូវបានទូទាត់ជាស្ប៉ា) ការដំណើរការ Doxygen នឹងបង្កើតចំណុចប្រទាក់កម្មវិធីរុករកតាមអ៊ីនធឺណិតដែលមានមូលដ្ឋានលើ HTML ជាមួយនឹងព័ត៌មានពាក់ព័ន្ធទាំងអស់អំពីមុខងារ/ថ្នាក់/អថេរ/ល។ រួមទាំងដ្យាក្រាមដែលពាក់ព័ន្ធដូចជាមរតកមរតក ឬដ្យាក្រាមសហការ។

ប៉ុន្តែចុះយ៉ាងណាបើផ្នែកខ្លះនៃកូដមិនត្រូវបានចងក្រងជាឯកសារ? គ្មាន​បញ្ហា! ជាមួយនឹងជម្រើសនៃការកំណត់រចនាសម្ព័ន្ធរបស់ Doxygen (ដែលមានលក្ខណៈទូលំទូលាយ) អ្នកអាចប្រាប់វាថាតើផ្នែកណាដែលមិនមានឯកសារគួរត្រូវបានរួមបញ្ចូលនៅក្នុងលទ្ធផលដែលបានបង្កើតយ៉ាងណាក៏ដោយ - វិធីនេះទោះបីជាមានចន្លោះប្រហោងក្នុងចំណេះដឹងអំពីផ្នែកខ្លះក៏ដោយ ពួកគេនឹងមិនត្រូវបានបាត់បង់ទាំងស្រុងពីទិដ្ឋភាពនៅពេលរុករកតាមរយៈ បាន​បង្កើត​ឯកសារ​នៅ​ពេល​ក្រោយ​នៅ​លើ​បន្ទាត់​!

លក្ខណៈពិសេសដ៏អស្ចារ្យមួយទៀតរបស់ Doxygen គឺការគាំទ្ររបស់វាសម្រាប់ការបង្កើតលទ្ធផលក្នុងទម្រង់ផ្សេងៗដូចជា RTF (MS-Word), PostScript/PDFs/hyperlinked PDFs/ compressed HTML/Unix man pages ជាដើម។ នេះមានន័យថាមិនថានរណាម្នាក់ចូលចិត្តឯកសាររបស់ពួកគេក្នុងទម្រង់បែបណានោះទេ។ ពួកគេទំនងជានឹងរកឃើញអ្វីដែលសមរម្យនៅទីនេះ!

ក្រាហ្វភាពអាស្រ័យនៃការដាក់បញ្ចូលដែលបានរៀបរាប់ពីមុនគឺជាលក្ខណៈពិសេសដ៏អស្ចារ្យមួយទៀត៖ ទាំងនេះបង្ហាញពីរបៀបដែលធាតុផ្សេងគ្នានៅក្នុងគម្រោងទាក់ទងគ្នាដោយមើលឃើញ ដូច្នេះអ្នកប្រើប្រាស់ទទួលបានគំនិតយ៉ាងឆាប់រហ័ស ដែលអ្វីៗគ្រប់យ៉ាងត្រូវនឹងកន្លែងដោយមិនចាំបាច់អានគ្រប់បន្ទាត់ដោយខ្លួនឯងជាមុន។ នេះជួយសន្សំសំចៃពេលវេលា ជាពិសេសនៅពេលធ្វើការជាមួយគម្រោងធំៗដែលមានធាតុផ្សំជាច្រើនដែលអាស្រ័យគ្នាទៅវិញទៅមក។

ដ្យាក្រាមមរតកផ្តល់អត្ថប្រយោជន៍ស្រដៀងគ្នាដោយបង្ហាញទំនាក់ទំនងរវាងថ្នាក់/ចំណុចប្រទាក់/ល ខណៈពេលដែលដ្យាក្រាមសហការបង្ហាញអន្តរកម្មរវាងវត្ថុផ្សេងៗគ្នានៅក្នុងថ្នាក់/ចំណុចប្រទាក់ដូចគ្នា/ល. /files/folders/etc..

សរុបមក យើងសូមណែនាំឱ្យសាកល្បងប្រើ DoxyGen ប្រសិនបើស្វែងរកឧបករណ៍ដែលងាយស្រួលប្រើ ប៉ុន្តែមានអនុភាពដែលអាចបង្កើតឯកសារគុណភាពខ្ពស់បានយ៉ាងឆាប់រហ័ស និងប្រកបដោយប្រសិទ្ធភាព!