Ebben a cikkben megismerheti a Swift megjegyzéseket, miért és hogyan használja őket.
A megjegyzés egy programozó által olvasható magyarázat vagy kommentár a program forráskódjában. A fordító a kód fordításakor figyelmen kívül hagyja.
A megjegyzéseket a kódot olvasó személyeknek szánják, hogy jobban megértsék a program szándékát és működését. Hasznos lehet, ha egy csapatnál dolgozik, hogy tisztázza a kód célját a többi csapattag számára, vagy ha kizárólag dolgozik, emlékeztethet a tulajdonra.
Gyors megjegyzés és típusai
Gyorsan kétféle megjegyzés létezik:
1. Egysoros megjegyzés
A Swiftben minden két //perjelrel kezdődő sor egyetlen soros megjegyzés //. A fordító figyelmen kívül hagy mindent, ami két perjellel kezdődik .
Egy egyszerű példát találhat a játszótér tetején:
//: Játszótér - főnév: az a hely, ahol az emberek játszhatnak
Két perjellel kezdődik, //és értelmes magyarázatot ad a fájlra: ": Játszótér - főnév: egy hely, ahol az emberek játszhatnak".
1. példa: Egysoros megjegyzés
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
A fenti példa két egysoros megjegyzést tartalmaz:
// Mintaprogram // tárolja a 3.14-et a pi változóban
2. Többsoros megjegyzés
Ha a megjegyzés több sort is tartalmaz, becsatolhatja azt /*… */.
A többsoros megjegyzések egy perjelsel, majd egy csillaggal ( /*) kezdődnek, és egy csillaggal végződnek, amelyet egy perjel ( */) követ . Mindent, ami közte van, /*és */a gyors fordító figyelmen kívül hagyja.
/ * Ez egy többsoros megjegyzés. Miután megírta a többsoros megjegyzést, adja hozzá * a / után a befejezéséhez * /
2. példa: Többsoros megjegyzés
/* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)
A fenti példa többsoros megjegyzést tartalmaz.
/ * A keménykódolt pi érték kevésbé pontos lehet. Tehát beépített adattípusokkal számolhat a pontosabb érték érdekében * /
Dolgok, amikre emlékezni kell
Bár a megjegyzések értelmesek a megírt kód szándékának jobb megértése érdekében. Íme néhány dolog, amelyet figyelembe kell vennie írásakor:
- Ne csatoljon megjegyzést a // sorral a többsorosra, bár ez érvényes, és a fordító figyelmen kívül hagyja ezeket a sorokat. Ehelyett csatolja a többsoros megjegyzésbe.
/*… */
Példa:// Ez egy megjegyzés. // Szükség esetén és pontosan használja
A fenti megjegyzésírás helyes, de nem ajánlott, mert többsoros megjegyzéseket kell írnia, ha a megjegyzés egy sornál nagyobb. A jobb írásmód a többsoros megjegyzés használata:/ * Ez egy megjegyzés. Szükség esetén és pontosan használja * /
- Az egysoros megjegyzés külön sorban vagy kóddal együtt írható ugyanabban a sorban. Javasoljuk azonban, hogy a megjegyzéseket külön sorban használja.
Példa:legyen pi = 3,14159 // 3,14-et tárol a pi változóban
Ez a megjegyzésírás érvényes. De jobb, ha a megjegyzést külön sorba írod:// a 3,14-et a pi változóban tárolja, legyen pi = 3,14159
- Még akkor is, ha egyedüli fejlesztő vagy egy csapatban, és csak te írod a kódot, ha nem kommentálod, akkor nehezen próbálod meg kitalálni a célját a programban. Tehát használja pontosan és adjon értelmes leírást.
- Tegye a megjegyzést nagyon egyszerűvé és értelmessé.
- Ne írjon felesleges megjegyzéseket a kódjára.
- A legtöbb esetben kommentekkel magyarázza inkább a „miért”, nem pedig a „hogyan” kifejezést.
