Doxygen 1.8.5

Doxygen - Иштеп чыгуучулар үчүн акыркы документация куралы

Иштеп чыгуучу катары, сиз кодуңуз үчүн так жана так документацияга ээ болуу канчалык маанилүү экенин билесиз. Тийиштүү документтерсиз код базасынын түзүмүн түшүнүү кыйын болуп, башаламандыкка жана каталарга алып келиши мүмкүн. Бул жерде Doxygen кирет - булак файлдарыңыздан онлайн документация браузерлерин жана оффлайн маалымдама колдонмолорун түзө турган күчтүү курал.

Doxygen – бул 1997-жылдан бери иштеп келе жаткан эркин жана ачык булактуу программа. Ал колдонуунун жөнөкөйлүгү, ийкемдүүлүгү жана күчтүү өзгөчөлүктөрү менен иштеп чыгуучулардын арасында эң популярдуу документация куралдарынын бири болуп калды. Doxygen менен сиз өзүңүздүн долбоорлоруңузга бир нече саат коротпостон, профессионалдуу көрүнгөн документтерди түзө аласыз.

Doxygenдин негизги өзгөчөлүктөрүнүн бири бул документацияны түздөн-түз баштапкы файлдарыңыздан алуу мүмкүнчүлүгү. Бул өзүнчө документация файлдарын жазуунун же коддук базаңыздан өзүнчө сактоонун кереги жок дегенди билдирет. Анын ордуна, сиз жөн гана Doxygen тааныган атайын тегдерди колдонуп, баштапкы файлдарыңызга комментарийлерди кошосуз.

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

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

Бирок кодекстин айрым бөлүктөрү документтештирилбесечи? Көйгөй жок! Doxygenдин конфигурациясынын параметрлери менен (алар кеңири), сиз ага кандай документсиз бөлүктөрдү генерацияланган чыгарууга кошуу керектигин айта аласыз - бул жол менен кээ бир аймактар ​​жөнүндө билимде боштуктар болсо да, аларды карап чыгууда алар толугу менен жок болуп кетпейт. документтер кийинчерээк түзүлдү!

Doxygenдин дагы бир сонун өзгөчөлүгү - бул RTF (MS-Word), PostScript/PDFs/гипершилтемеленген PDF файлдары/кысылган HTML/Unix адам барактары ж.б. сыяктуу ар кандай форматтарда чыгарууну колдоо. Бул кимдир бирөө өзүнүн документтерин кандай форматта жактырбасын дегенди билдирет. алар бул жерден ылайыктуу нерсени табышы мүмкүн!

Мурда айтылган камтууга көз карандылык графиктери дагы бир сонун өзгөчөлүк болуп саналат: булар долбоордун ичиндеги ар кандай элементтердин бири-бирине визуалдык түрдө кандай байланышы бар экенин көрсөтүп турат, ошондуктан колдонуучулар ар бир сапты алдын ала окубай туруп, баары өз ордуна туура келген жерде тез түшүнүк алышат; Бул, өзгөчө, көп өз ара көз каранды компоненттерди камтыган ири долбоорлор менен иштөөдө убакытты үнөмдөйт.

Мурас диаграммалары класстардын/интерфейстердин/ж.б. ортосундагы мамилелерди көрсөтүү менен окшош пайдаларды берет, ал эми кызматташуу диаграммалары ошол эле класстар/интерфейстер/ж.б. ичиндеги ар кандай объектилердин ортосундагы өз ара аракеттенишүүнү көрсөтөт.. Үч түрү тең бир нече модулдарга чачыраган контексттен тышкаркы үзүндүлөрдү түшүнүүгө жардам берет. /файлдар/папкалар/ж.б.

Жалпысынан алганда, DoxyGen'ди сынап көрүүнү сунуштайбыз, эгерде колдонууга оңой, бирок жогорку сапаттагы документтерди тез жана эффективдүү түзө алган күчтүү курал издеп!