Programinės įrangos kūrimo pasaulyje kiekvienas kūrėjas yra susipažinęs su patikimu komentaru. Jis dažnai naudojamas kaip greitas priminimas, kad vėlesniame etape reikia pakartotinai peržiūrėti kodą, perdaryti arba atlikti užduotį. Tačiau laikui bėgant šie komentarai gali kauptis ir tapti tyliomis techninių skolų sankaupomis – paslėpta našta, kuri gali turėti įtakos projekto sveikatai ir techninei priežiūrai. TODO TODO Jei nepažymėti, šie išsibarstę priminimai gali apsunkinti kodų bazę, todėl kūrėjams bus sunkiau naršyti, derinti ir išplėsti. Savo darbe aš susidūriau su šia problema iš pirmų lūpų ir galiausiai nusprendžiau ją išspręsti naudodamas įrankį, kuris padaro techninę skolą matomą ir veiksmingą: . Todoctor https://github.com/azat-io/todoctor?embedable=true Paslėpta komentarų problema TODO Iš pradžių komentaras gali atrodyti nekenksmingas ar net naudingas. Tai signalas kūrėjams ką nors peržiūrėti – galbūt optimizuoti algoritmą, pertvarkyti sudėtingą skyrių, pakeisti pasenusią priklausomybę arba užbaigti vis dar vykdomą funkciją. Tačiau dėl įtempto grafiko, besikeičiančių prioritetų ir griežtų terminų šie dažnai atidedami neribotam laikui. Užuot į juos kreiptasi, jie tampa neišspręstų dalykų artefaktais. TODO TODO Laikui bėgant, komentarai gali sukelti keletą problemų: TODO : komentarų sankaupa sukuria iliuziją, kad kodas yra gerai prižiūrimas, o iš tikrųjų jis slepia neužbaigtas užduotis ir neišspręstas problemas. Nematoma techninė skola TODO : Neatsižvelgus į šiuos komentarus gali atsirasti klaidų, sunkiai prižiūrimo kodo ir netikėto elgesio. Sumažėjusi kodo kokybė : Laikui bėgant kūrėjai gali pamiršti kiekvieno tikslą, ypač kai komandos nariai ateina ir išeina. Tai veda prie didėjančio kodo ir komandos supratimo apie jį atotrūkio. Konteksto praradimas TODO Didesniuose projektuose arba projektuose, kuriuose dalyvauja keli dalyviai, problema tik didėja. Be reguliaraus dėmesio gali būti išsklaidyti visoje kodų bazėje, todėl sunku valdyti ir sekti technines skolas. TODO Sprendimas: padarykite techninę skolą matomą su Todoctor Spręsdamas šią problemą supratau, kad reikia įrankio, leidžiančio komentarus iš slėptuvės iškelti į veiksmingą erdvę, kurioje komandos galėtų lengvai juos įvertinti ir spręsti. Dėl to buvo sukurta – CLI priemonė, skirta analizuoti ir sekti komentarus „JavaScript“ ir „TypeScript“ kodų bazėse. TODO „Todoctor“ TODO Naudodami „Todoctor“ kūrėjai ir komandos gali vizualizuoti ir valdyti savo technines skolas laikui bėgant, padėdami jiems priimti pagrįstus sprendimus dėl valymo ir pertvarkymo prioritetų. Štai kaip tai veikia: viešosios interneto prieigos taškus: Todoctor nuskaito kodų bazę, kad surastų kiekvieną komentarą, renka informaciją apie kiekvieno komentaro amžių, autorių ir turinį. Nustatykite TODO TODO : tada sugeneruojama ataskaita su diagrama, iliustruojančia, kaip laikui bėgant keitėsi skaičius, todėl komandoms pateikiamas aiškus jų techninės skolos vaizdas. Vizualizuokite techninę skolą TODO : naudodami Todoctor galite sekti kiekvieno amžių, pamatyti, kas jį sukūrė, ir peržiūrėti rūšiuojamą visų laukiančių užduočių sąrašą kodų bazėje. Skatinkite atskaitomybę TODO Per šiuos rodiklius Todoctor techninę skolą paverčia matomu, valdomu projekto elementu. Šis skaidrumas gali paskatinti komandas imtis veiksmų, susijusių su išskirtinėmis užduotimis, ir padeda puoselėti kodo nuosavybės ir kokybės kultūrą. Žvilgsnis į Todoctor techninį įgyvendinimą „Todoctor“ buvo sukurta atsižvelgiant į paprastumą ir patogumą naudoti, todėl jį galima sklandžiai integruoti į bet kokią kūrimo darbo eigą. Įrankis parašytas „JavaScript“ ir veikia kaip CLI įrankis, todėl jį lengva nustatyti ir paleisti naudojant vieną komandą. Kiekvienam komentarui Todoctor renka metaduomenis, tokius kaip: TODO : kiek laiko buvo kodų bazėje. Komentarų amžius TODO Bendras : paprastas skaičiavimas, leidžiantis stebėti skolos dydį. TODO skaičius Vidutinis : momentinė užduočių atlikimo trukmė. TODO amžius : sąrašas, kuriame rodoma, kurie komandos nariai sukūrė daugiausiai , todėl komandos gali tęsti konkrečias užduotis. Geriausi bendradarbiai TODO Naudodamas šiuos duomenis, Todoctor sukuria išsamią HTML ataskaitą, kurią galima įtraukti į kodų bazę arba bendrinti su komanda. Norėdami pradėti naudoti „Todoctor“, tiesiog įdiekite jį ir projekto šaknyje paleiskite šią komandą: npx todoctor Per kelias sekundes „Todoctor“ išanalizuos jūsų kodų bazę ir sugeneruos ataskaitą, kuri suteiks jums visą techninės skolos vaizdą ir įžvalgas, kurias galima įgyvendinti. Kodėl svarbu vizualizuoti techninę skolą Techninė skola gali atrodyti kaip nedidelė problema, kol ji nepradės sulėtinti kūrimo ir paveikti kodo kokybę. komentarai, nors ir naudingi trumpuoju laikotarpiu, gali lengvai tapti pamirštais įsipareigojimais, kuriuos galiausiai reikia išspręsti. Padarydamas šiuos priminimus matomus ir išmatuojamus, „Todoctor“ suteikia komandoms galimybę susigrąžinti savo kodų bazės kontrolę, užtikrinant, kad ji išliktų prižiūrima ir paruošta tolesniam augimui. TODO : Išbandykite Todoctor https://github.com/azat-io/todoctor?embedable=true
