Obsah:
Definícia - Čo znamená komentár?
Komentár je špeciálna konštrukcia v programovacom jazyku, ktorá umožňuje vývojárovi programu spomenúť ďalšie informácie spojené s programom. Hlavným dôvodom zahrnutia komentárov do programovacích jazykov je zlepšenie prenosnosti a udržiavateľnosti kódu.
Techopedia vysvetľuje komentár
Tímy pre vývoj softvéru často často spolupracujú na rôznych softvérových moduloch, ktoré počas testovacieho procesu kontrolujú technici. Počas procesu testovania musia byť inžinieri oboznámení s fungovaním modulu. Preto vývojár zahŕňa komentáre na vysvetlenie fungovania konkrétneho modulu uvedením platných typov vstupov, počtu vstupov, algoritmu použitého na spracovanie vo vnútornom module, očakávaných výstupov a chybových stavov, ktoré sa môžu vyskytnúť. počas spracovania.
Komentáre tiež často poskytujú informácie o autorovi obsahu, dátume a čase, kedy boli vyvinuté, a dátume a čase poslednej úpravy. Koľko podrobností je potrebné zahrnúť, je vecou subjektivity. Niektorí vývojári sú preslávení tým, že nenávidia komentáre a považujú ich za stratu času. Pre ostatných sú komentáre absolútnou nevyhnutnosťou. Teoreticky by organizácia mala stanoviť všetky svoje štandardy kódovania. Napriek tomu z akéhokoľvek dôvodu vám niekto, kto zdedil kód od predchádzajúceho vývojového tímu, povie viackrát, ako to, že tento kód nemá komentáre, ktoré by radi videli.
