In dit artikel leert u over Swift-opmerkingen, waarom en hoe u ze kunt gebruiken.
Een commentaar is een door de programmeur leesbare uitleg of annotatie in de broncode van een programma. Het wordt genegeerd door de compiler wanneer de code wordt gecompileerd.
Opmerkingen zijn bedoeld voor personen die de code lezen om de bedoeling en functionaliteit van het programma beter te begrijpen. Het kan handig zijn om in een team te werken om het doel van de code voor andere teamleden te verduidelijken of als je er alleen aan werkt, kan het dienen als een herinnering om eigenaar te zijn.
Snelle reactie en zijn typen
In het kort zijn er twee soorten opmerkingen:
1. Commentaar op één regel
In Swift is elke regel die begint met twee schuine strepen //een commentaar van één regel. Alles dat begint met twee schuine strepen //wordt genegeerd door de compiler.
Bovenaan de speeltuin vind je een eenvoudig voorbeeld:
//: Playground - zelfstandig naamwoord: een plek waar mensen kunnen spelen
Het begint met twee schuine strepen //en geeft een zinvolle uitleg van het bestand als ": Speeltuin - zelfstandig naamwoord: een plek waar mensen kunnen spelen".
Voorbeeld 1: commentaar op één regel
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Het bovenstaande voorbeeld bevat twee enkele regelcommentaar:
// Voorbeeldprogramma // slaat 3.14 op in variabele pi
2. Commentaar op meerdere regels
Als uw opmerking meerdere regels bevat, kunt u deze binnen plaatsen /*… */.
Opmerkingen met meerdere regels beginnen met een schuine streep, gevolgd door een asterisk ( /*) en eindigen met een asterisk, gevolgd door een schuine streep naar voren ( */). Alles daar tussenin /*en */wordt genegeerd door de snelle compiler.
/ * Dit is een opmerking met meerdere regels. Nadat u een commentaar op meerdere regels hebt geschreven, voegt u * toe gevolgd door / om het te beëindigen * /
Voorbeeld 2: commentaar op meerdere regels
/* 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)
Het bovenstaande voorbeeld bevat een opmerking met meerdere regels.
/ * Hardgecodeerde pi-waarde is mogelijk minder nauwkeurig. U kunt dus rekenen met ingebouwde gegevenstypen voor een nauwkeurigere waarde * /
Dingen om te onthouden
Hoewel opmerkingen zinvol zijn om de bedoeling van de geschreven code beter te begrijpen. Hier zijn dingen waarmee u rekening moet houden tijdens het schrijven:
- Plaats geen commentaar met // op multiline, hoewel het geldig is en de compiler die regels negeert. Plaats het in plaats daarvan in een commentaar met meerdere regels
/*… */
Voorbeeld:// Dit is een opmerking. // Gebruik het indien nodig en precies
De bovenstaande manier om commentaar te schrijven is correct, maar wordt niet aanbevolen, omdat u commentaar uit meerdere regels moet schrijven als het commentaar groter is dan één regel. De betere manier om te schrijven is door commentaar op meerdere regels te gebruiken, zoals:/ * Dit is een opmerking. Gebruik het indien nodig en precies * /
- Commentaar van één regel kan op een aparte regel worden geschreven of samen met code op dezelfde regel. Het wordt echter aanbevolen om opmerkingen op een aparte regel te gebruiken.
Voorbeeld:let pi = 3.14159 // slaat 3.14 op in variabele pi
Deze manier om opmerkingen te schrijven is geldig. Maar het is beter om commentaar op een aparte regel te schrijven als:// slaat 3.14 op in variabele pi laat pi = 3.14159
- Zelfs als je een enkele ontwikkelaar in een team bent, en je bent de enige die de code schrijft, als er geen commentaar op staat, zal het moeilijk zijn om het doel ervan in het programma te achterhalen. Gebruik het dus nauwkeurig en geef een zinvolle beschrijving.
- Maak commentaar heel eenvoudig en zinvol.
- Schrijf geen onnodige opmerkingen over uw code.
- Gebruik in de meeste gevallen opmerkingen om uit te leggen 'waarom' in plaats van 'hoe'.
