Doxygen 1.8.5

Doxygen - An Uirlis Doiciméadúcháin Deiridh d'Fhorbróirí

Mar fhorbróir, tá a fhios agat cé chomh tábhachtach agus atá sé doiciméadú soiléir agus beacht a bheith agat le haghaidh do chód. Gan doiciméadú cuí, féadann sé a bheith deacair struchtúr do bhunachar cód a thuiscint, rud a fhágann go mbíonn mearbhall agus earráidí ann. Sin an áit a dtagann Doxygen isteach - uirlis chumhachtach atá in ann brabhsálaithe doiciméadaithe ar líne agus lámhleabhair thagartha as-líne a ghiniúint ó do bhunchomhaid.

Is bogearraí saor in aisce agus foinse oscailte é Doxygen atá thart ó 1997. Tá sé anois ar cheann de na huirlisí doiciméadaithe is coitianta i measc forbróirí mar gheall ar a éasca le húsáid, solúbthacht, agus gnéithe cumhachtacha. Le Doxygen, is féidir leat doiciméadú gairmiúil a chruthú do do thionscadail go héasca gan uaireanta a chaitheamh á scríobh tú féin.

Ceann de phríomhghnéithe Doxygen is ea a chumas doiciméadú a bhaint go díreach ó do chomhaid foinse. Ciallaíonn sé seo nach gá duit comhaid doiciméadúcháin ar leith a scríobh nó iad a choinneáil ar leithligh ó do bhunachar cód. Ina áit sin, ní dhéanann tú ach tráchtanna a chur le do chomhaid foinse ag baint úsáide as clibeanna speisialta a aithníonn Doxygen.

Ligeann na clibeanna seo duit gnéithe éagsúla de do chód a dhoiciméadú, mar shampla feidhmeanna, ranganna, athróga, agus go leor eile. Is féidir leat freisin faisnéis a chur san áireamh faoi pharaiméadair, luachanna tuairisceáin, eisceachtaí arna gcaitheamh ag feidhmeanna nó modhanna etc., rud a fhágann go mbeidh sé níos éasca d’fhorbróirí eile (nó fiú duit féin) tuiscint a fháil ar conas a oibríonn an cód.

Nuair a bheidh na tuairimí seo curtha agat le do chomhaid foinse (a d’fhéadfadh a bheith tedious ar dtús ach a n-íocann as i rámhainní), má ritheann tú Doxygen ginfidh comhéadan brabhsálaí HTML-bhunaithe leis an bhfaisnéis ábhartha ar fad faoi gach feidhm/aicme/athróg/srl. , lena n-áirítear aon léaráidí gaolmhara cosúil le crainn oidhreachta nó léaráidí comhoibrithe.

Ach cad a tharlóidh mura bhfuil codanna áirithe den chód doiciméadaithe? Fadhb ar bith! Le roghanna cumraíochta Doxygen (atá fairsing), is féidir leat a rá cé na codanna neamhdhoiciméadaithe ar cheart a chur san áireamh san aschur ginte - ar an mbealach seo fiú má tá bearnaí san eolas faoi réimsí áirithe ní bheidh siad in easnamh go hiomlán agus tú ag brabhsáil tríd doiciméid ginte níos déanaí síos-an-líne!

Gné iontach eile de Doxygen is ea an tacaíocht a thugann sé d’aschur a ghiniúint i bhformáidí éagsúla mar RTF (MS-Word), PostScript/PDFs/PDFanna hipearnasc/leathanaigh fear HTML/Unix comhbhrúite srl. i is dócha go bhfaighidh siad rud éigin oiriúnach anseo!

Gné iontach eile is ea na graif spleáchais chuimsithe a luadh níos luaithe: léiríonn siad seo an gaol idir gnéithe éagsúla laistigh de thionscadal le chéile go radhairc ionas go bhfaigheann úsáideoirí smaoineamh go tapa ar an áit a n-oireann gach rud gan léamh trí gach líne iad féin roimh ré; sábhálann sé seo am go háirithe agus tú ag obair le tionscadail mhóra ina bhfuil go leor comhpháirteanna idirspleácha.

Soláthraíonn léaráidí oidhreachta tairbhí comhchosúla trí ghaolmhaireachtaí idir ranganna/comhéadain/srl. a thaispeáint, agus taispeánann léaráidí comhoibrithe idirghníomhaíochtaí idir réada difriúla laistigh de na haicmí/comhéadain/srl sin. /comhaid/fillteáin/etc.

Ar an iomlán, molaimid go mór triail a thabhairt do DoxyGen má tá uirlis chumhachtach atá éasca le húsáid á lorg agat atá in ann doiciméid ardchaighdeáin a ghiniúint go tapa agus go héifeachtach!