Skip to content

Forráskód konvenciók

Miért?
A kódot gyakrabban olvassák, mint írják. Ezért fontosak a konvenciók, melyek segítik a kód gyors olvasását és felfogását.

A következő aspektusokat tartjuk fontosnak:
  • Névkonvenció
  • Helyes kommentelés

Ezzel nem azt akarjuk mondani, hogy más konvenciók feleslegesek, hanem csak azt, hogy ezzel a kettővel kellene kezdeni, mert ezek annyira alapvetőnek tűnnek. Bármilyen kódkonvencióról legyen szó, a legfontosabb, hogy nem a konkrét kidolgozása a lényeg, hanem a konvenciók konzekvens betartása. És fontos az, hogy tudatos legyen a konvenciók szükségessége.

Névkonvenciók

Miért?
Névkonvenciók nélkül az embernek újra és újra az egyes fejlesztőkre kell ráhangolódnia.

A névkonvencióknak az a feladata, hogy támogassák az olvasót abban, hogy megértse a kódot. Mivel pl. hasznos lehet a helyi változók megkülönböztetése a mezőktől, ezért ezt lehetne támogatni egy névkonvencióval. Hogy egy ilyen konvenció az adott esetben hogyan néz ki, az már ízlés kérdése. Egyesek a „this.xyz”-t szeretik, mások a „_xyz”-t. Hogy melyik változatot használjuk az nem fontos. Nekünk csak az fontos, hogy a konvenciókat konzekvensen betartsák. Továbbá a mezők névkonvenciójának szükségessége a kontextustól függ. Egy 400 soros osztályban nagyon fontosnak tartanánk egy olyan névkonvenciót, amelyik megkülönbözteti a változókat és a mezőket, míg átlátható osztályokban ez inkább a háttérbe szorul. A Root Cause Analysis segítségével a Clean Code fejlesztők a névkonvenciók szükségességének okát kutatják.

Helyes kommentelés

Miért?
A felesleges vagy hibás kommentek feltartják az olvasót. A kódnak olyan tisztának és érhetőnek kellene lennie, hogy megálljon kommentek nélkül.

Pongyola fogalmazásban: Egy komment a kódban annak a jele, hogy még lehet javítani a kódon. Ennek tipikus esete, amikor 3 sor kód fölött egy komment helyezkedik el. Ebben az esetben valószínűleg segíthet az, hogy kiemeljük a három sort egy eljárásba (Refactoring: Extract Method), és a kommentet az eljárás neveként használjuk. Általánosan a kommentek szükségességét azzal lehet csökkenteni, hogy a változóknak, eljárásoknak, osztályoknak stb. jó nevet adunk.

A következő helyett

    int hossz; // mm-ben

jobb volna:

    int hosszMmBen;

A következő helyett:

    public double Ár() {
        // kiszámolja a bruttó árat...
    }

jobb volna:

    public Money BruttoÁr() {
        ...
    }

Nem azt kellene kommentelni, amit az ember tesz, hanem sokkal inkább azt, hogy miért tette ezt.

Published inElvek