238
тегжейлерге
келетін болсақ, бағдарламашылар дәл болмауы мүмкін
құжаттаманы оқығанша, бағдарламалық кодты қарастырғанды қалайды.
Осыдан, құжаттаманы қанағаттандырусыз қолданудың тағы бір себебі,
олардың әртүрлі дереккөздерде сақталуында болып табылады және
қосымшаны жаңарту кезінде әрдайым құжаттама сәйкесінше
өзгертілмейді.
Мәселенің шешімі кодты және құжаттаманы бір дереккөзде сақтау
болып табылады. Жақсы құжатталған код бағдарламаның жақсы
сапасына кодты жазу кезінде және
жоба логикасын іске асыру
түсінігінде де септігін тигізеді. Құжаттама және код бірігіп бір
дереккөзде болған жағдайда бұл кодтың анықтығын, бағдарламалық
қамсыздандырудың барлық өмірінің барысында құжаттаманы үнемі
сүйемелдеу мүмкіндігі мен ыңғайлылығын арттырады. Код, техникалық
құжаттама және пікірлер тұтастай бірыңғай түрінде
басқарылады,
олардың келіспеушілігі орын алмайды. Құжаттама генераторы екі
тәсілмен қолданылады:
1) құжаттама метадеректердің анықтамаларынан, кодпен бірге бір
мезгілде генерацияланады, сонымен бірге метадеректердің бір бөлігі
кодтың өзіне және құжаттамаға енгізілетін
пікірлер болуы тиіс;
2) бағдарламалық кодтан код және пікірлердің маңызды блоктары
іріктеледі, осы ақпараттан құжаттама құралады. Бұл нұсқа өте
ыңғайлы, себебі құжаттама код тұрған жерде орналасады.
Өзекті және толық құжаттаманы жүргізудің ең басты сәттері, бұл -
пікірлер жүйесін сауатты ұйымдастыру болып табылады.
Құжаттаманы генерациялаудың артықшылықтары келесілер:
■
құжаттама бағдарламалық кодпен келісілген болады, яғни нақтырақ
және өзекті болады;
■
құжаттаманы әзірлеуге қажетті уақыт пен күштің
едәуір мөлшері
үнемделеді. Босатылатын уақыт және ресурстарды құжаттаманың
сапасын жақсарту үшін қолдануға болады;
■
құжаттаманы берудің форматын немесе стилін өзгерту процесі
қарапайымдылаурақ болады. Өз генераторы болған жағдайда, әрбір
құжаттың форматын өзгерту қажет емес, үлгіні өзгерткен жеткілікті;
■
құжаттама анағұрлым жылдам құрылады.
Достарыңызбен бөлісу: