Obsah:
Definice - Co znamená komentář?
Komentář je speciální konstrukce v programovacím jazyce, která umožňuje vývojáři programu zmínit další informace spojené s programem. Hlavním důvodem pro zahrnutí komentářů do programovacích jazyků je zlepšení přenositelnosti a udržovatelnosti kódu.
Techopedia vysvětluje komentář
Týmy pro vývoj softwaru často často spolupracují na různých softwarových modulech, které jsou kontrolovány testovacími inženýry během testovacího procesu. Během procesu testování si musí být inženýři vědomi fungování modulu. Vývojář proto zahrnuje komentáře, které vysvětlují fungování konkrétního modulu uvedením platných typů vstupů, počtu vstupů, algoritmu použitého pro zpracování ve vnitřním modulu, očekávaných výstupů a chybových stavů, které mohou nastat. během zpracování.
Komentáře také často poskytují informace o autorovi obsahu, datu a čase, kdy byl vytvořen, a datu a čase, kdy byl naposledy změněn. Kolik podrobností je třeba zahrnout, je otázkou subjektivity. Někteří vývojáři jsou proslulí tím, že nenávidí komentáře a považují je za ztrátu času. Pro ostatní jsou komentáře naprostou nutností. Teoreticky by organizace měla stanovit všechny své standardy kódování. Přesto z jakéhokoli důvodu vám kdokoli, kdo zdědil kód od předchozího vývojového týmu, řekne vícekrát než ne, že kód nemá komentáře, které by rád viděl.
