Nincs megjegyzés? Ez elfogadhatatlan!

BecomeAnXcoder – Nincs megjegyzés? Ez elfogadhatatlan!

Bevezető

Beszédes változóneveket használva a programjaink olvashatóbbak és érthetőbbek lesznek [1].

//[1]
float pictureWidth, pictureHeight, pictureSurfaceArea; 
pictureWidth = 8.0;
pictureHeight = 4.5; 
pictureSurfaceArea = pictureWidth * pictureHeight;

Bár eddigi példáink csak néhány soros programok voltak, de még egy egyszerű program is könnyen több száz, vagy akár több ezer soros programmá is kinőheti magát és ha pár héttel, vagy hónappal később ismét elővesszük a kódot, nem biztos, hogy minden részletére pontosan emlékezni fogunk, hogy mit miért csináltunk. De erre valók a programkódba illesztett megjegyzések. A megjegyzések sokat segítenek abban, hogy gyorsan megértsük az egyes programrészletek feladatát. Vannak olyan programozók akik egyenesen megjegyzések írásával kezdik a programírást, azok segítségével állítják fel a program szerkezetét, ami egy könnyen áttekinthető kódot eredményez.

Feltétlenül javasoljuk, hogy szánjál egy kis időt arra, hogy megjegyzéseket helyezz el a programkódba. Garantáljuk hogy ezzel sok időt megspórolsz magadnak a későbbiekben, ha majd ismét előveszed a kódodat. De akkor is nagyon hasznos, ha megosztod másokkal a munkádat és ők szeretnék azt beilleszteni a saját kódjukba gyorsan és egyszerűen.

Megjegyzések írása

A megjegyzéseket két egymás melletti törtvonallal kell kezdeni a kódban.

// Ez egy megjegyzés

Az Xcode-ban a megjegyzések zöld színben jelennek meg. Ha hosszú, többsoros megjegyzést szeretnénk elhelyezni, akkor /* */ jelek közé is lehet írni.

/* Ez egy 
több soros megjegyzés */

Kikommentezés

Hamarosan tárgyalni fogjuk a hibakeresést és bemutatjuk, hogy az Xcode milyen nagyszerű lehetőségeket biztosít számunkra ezen a területen. A kikommentezés egy régi hibakeresési technika. A programkód egy részét a /* */ jelekkel megjegyzéssé változtatjuk, azaz kikommentezzük, amivel az adott programrészletet ideiglenesen kiiktatjuk. Így ellenőrizni tudjuk, hogy a maradék program elvárásainknak megfelelően működik-e. Ez segíthet abban, hogy levadásszuk a hibás részt. Amennyiben az így kiiktatott rész aktív, például értéket ad egy változónak, akkor beilleszthetünk egy ideiglenes sort ahol beállítjuk a változó szükséges értékét.

Miért írjunk megjegyzéseket?

A megjegyzések fontosságát nehéz eltúlozni. Gyakran hasznos ha néhány emberi mondatban elmagyarázzuk, hogy egy kódrészlet valójában mire is való. Ha nem kell időt töltened azzal, hogy kitalálod a programrész működését, sokkal gyorsabban el tudod dönteni, hogy a keresett probléma az adott részben van, vagy valahol máshol kell azt keresni. A megjegyzések segíthetnek kitalálni olyan dolgokat is amikre közvetlenül nagyon nehéz, vagy szinte lehetetlen rájönni. Például ha a program egy olyan matematikai modellt használ, amelyik kevésbé közismert, akkor célszerű elhelyezni egy irodalmi utalást arra, hol lehet megtalálni a szükséges elméleti alapokat.

Néha hasznos lehet már a programozás kezdetén megjegyzések segítségével kialakítani a program szerkezetét. Ez segít a program strukturálásában és megkönnyíti a programfejlesztést a későbbiekben.

Ebben a könyvben található programkódok nem tartalmaznak annyi megjegyzést, mint amennyit el szoktunk helyezni a programjainkban. Ez csak azért van így, mert a környező szövegek segítségével is magyarázzuk azok jelentését.

 

eredeti oldal