Programozási tippek

Függvények elnevezése

A jó függvénynevek megválasztása elengedhetetlen része a jó kód írásának. Amikor elnevezed a függvényedet, vedd figyelembe a következő javaslatokat.

Válassz beszédes függvényneveket

Amikor elnevezed a függvényt, legyen világos, hogy mit csinál. Például a get(studentId, subject) függvény neve nem beszédes, ezért nem derül ki belőle, hogy mit csinál. Lehet, hogy a tanuló tantárgyból kapott jegyét kéri le, de az is lehet, hogy a beiratkozási státuszát. Jobb név lenne a getStudentGrade(studentId, subject), mert pontosan megmondja, mit csinál a függvény.

Ne legyen túl hosszú a függvénynév

Ügyelj rá, hogy a függvénynév ne legyen túl hosszú. Például a checkStudentFailOrPassOrMeritOrDistinction(mark) feleslegesen hosszú függvénynév. Minél hosszabb a név, annál nehezebb megjegyezni, és annál több helyet foglal a képernyőn.

Ne legyen túl rövid a függvénynév

Fordítva is igaz: a túl rövid függvénynév szintén összezavarhatja az olvasókat. Például a checkFPMD(mark) rossz függvénynév, mert első pillantásra nem derül ki, mit jelent az „FPMD”.

Olyan nevet használj, amit mindenki megért

A függvényneved legyen érthető mindenkinek, aki olvassa a kódodat. Például egy homályos függvénynév, mint a DeathStar(), lehet, hogy szórakoztatónak tűnik neked, de nem árulja el a célját, és összezavarhatja a kódodat olvasó fejlesztőket.

Egyetlen konvenciót kövess a műveletek elnevezésében

Tartsd magad egyetlen konvencióhoz az ugyanazt csináló műveletek elnevezésében. Például ha a tanuló nevének lekérdezésére szolgáló függvényt getStudentName()-nek nevezed el, akkor a tanuló jegye esetében ne használj más igét a függvénynévben (pl. retrieveStudentGrade()).

Ne használd ugyanazt a szót két célra

Például ne ragaszkodj az add névhez, amikor elemek egy csoportját teszed egy gyűjteménybe, ha ugyanezt a nevet már a két szám összeadására használtad. Helyette használd az insert vagy az append nevet.