Tartalomjegyzék:
Meghatározás - Mit jelent a megjegyzés?
A megjegyzés egy speciális konstrukció egy programozási nyelven, amely lehetővé teszi a programfejlesztőnek, hogy megemlítse a programhoz kapcsolódó kiegészítő információkat. A megjegyzésnek a programozási nyelvekbe való beillesztésének fő oka a kód hordozhatóságának és karbantarthatóságának javítása.
A Techopedia magyarázza a megjegyzést
Gyakran a szoftverfejlesztő csapatok különböző szoftvermodulokon dolgoznak együtt, amelyeket a tesztelési mérnökök ellenőriznek a tesztelési folyamat során. A tesztelés során a mérnököknek tisztában kell lenniük a modul működésével. Ezért a fejlesztő hozzászólásokat tartalmaz egy adott modul működésének magyarázata érdekében, megadva az érvényes bemeneti típusokat, a bemenetek számát, a belső modulban történő feldolgozáshoz használt algoritmust, a várható kimeneteket és a fellépő hibahelyzeteket. feldolgozás közben.
A megjegyzések gyakran tartalmaznak információkat a tartalom szerzőjéről, a kidolgozásának dátumáról és idejéről, valamint a legutóbbi módosításának dátumáról és idejéről is. A mennyi részletet bele kell foglalni a szubjektivitás kérdése. Egyes fejlesztők hírhedtek, mert utálják a megjegyzéseket, és időpocsékolásnak tekintik őket. Másoknak az észrevételek feltétlenül szükségesek. Elméletileg egy szervezetnek meg kell határoznia minden kódolási szabványát. Mégis, bármilyen okból, bárki, aki egy korábbi fejlesztői csoporttól örökölte a kódot, többször is elmondja neked, hogy a kódnak nincs megjegyzése, amelyet szeretnének látni.