Jelenlegi hely

24.3.1 Implementációs megjegyzések

A programok négyféle implementációs megjegyzést tartalmazhatnak: blokk, egysoros, nyomkövetési és sorvégi.

Blokk megjegyzések

A blokk megjegyzések leírást tartalmaznak a fájlhoz, metódushoz, adatszerkezethez vagy algoritmushoz. Fájl esetén a fájl elején, a többi esetben a metódus belsejében szokás elhelyezni, alkalmazkodva a megjegyzéssel ellátott egység behúzásához.

A blokk megjegyzés egy üres sorral kezdődik és fejeződik is be:

/*
* Blokk megjegyzés.
*/

Egysoros megjegyzések

A rövid megjegyzéseket egyetlen sorba írva, a bekezdési szintet figyelembe véve lehet elhelyezni. Ha nem lehet egy sorba írni, akkor blokk megjegyzést érdemes alkalmazni. Egy üres sor után érdemes írni a megjegyzést, hogy vizuálisan láthatók legyenek az összefüggések.

if (feltétel) {

    /* Eset leírása. */
    ...
}

Nyomkövetési megjegyzések

Nagyon rövid megjegyzéseket az adott kódsor végére is lehet írni, megfelelő közzel elválasztva a kódtól. Célszerű az egymás utáni nyomkövetési megjegyzéseket azonos pozícióban kezdeni. A következő példa mutatja a használat módját:

if (a % 2 == 0) {
    return TRUE;            /* páros szám esetén kész */
} else {
    return isPrime(a);      /* különben vizsgáljuk */
}

Természetesen alkalmazható a // is, de csak következetesen, nem keverve a két módot. Nem érdemes olyan megjegyzéseket alkalmazni, amik a későbbi megértést nem segítik elő jelentősen.

Megjegyzés: A jegyzet példái oktatási célból készültek, sokszor túl részletesen kommentezve. Valódi fejlesztéskor csak a ténylegesen szükséges megjegyzéseket érdemes elhelyezni.