Amikor számítógépen programoz, néha megjegyzéseket vagy megjegyzéseket kell hagynia, hogy más fejlesztők könnyedén böngészhessék a kódot. Legyen szó nyílt forráskódú vagy saját fejlesztésű projektről, megjegyzésekre van szükség ahhoz, hogy a társfejlesztőkkel és a jövőbeli fejlesztőkkel is összehangolhassuk őket. Megjegyzések nélkül a kód egyszerűen karbantarthatatlan lenne.
Lépések
1. lépés: Ismerje meg egy számítógépes program megjegyzésének célját
- Az olvashatóság itt a legfontosabb. Amikor megnéz egy megjegyzést, tudnia kell, hogy ez megjegyzés, és nem kódsor.
- A megjegyzésnek nemcsak Önnek, hanem bárki másnak is hasznosnak kell lennie, aki esetleg elolvassa a számítógépes program forráskódját.
2. lépés. Gondoljon egy rövid, egyszerű módra, amellyel átláthatja az álláspontját
A megjegyzéseknek nem kell műalkotásnak lenniük. Tömörnek, ügyesnek és egyenesnek kell lenniük.
Ennek azonban nem szabad elriasztania a többsoros megjegyzések használatát. A lényeg az, hogy az információnak el kell jutnia az olvasóhoz
3. lépés. Írja meg a megjegyzést a programozási nyelv megfelelő szintaxisával
4. lépés. Kérdezze meg magától, hogy az Ön által írt megjegyzés elég részletes -e
Egy megjegyzésnek meg kell tudnia mondani valakinek, aki a forráskódot nézi, hogy a programnak ez a része mit csinál valójában anélkül, hogy le kellene fordítania és futtatnia. A hozzászólásod teljesíti ezt? Minden részletet közvetít?
