În acest articol, veți afla despre comentariile Swift, de ce și cum să le utilizați.
Un comentariu este o explicație sau adnotare lizibilă de programator în codul sursă al unui program. Acesta este ignorat de compilator atunci când codul este compilat.
Comentariile sunt destinate persoanei care citește codul pentru a înțelege mai bine intenția și funcționalitatea programului. Poate fi util în timp ce lucrați într-o echipă pentru a clarifica scopul codului pentru ceilalți membri ai echipei sau în timp ce lucrați numai poate acționa ca un memento de a deține.
Comentariul rapid și tipurile sale
În rapid există două tipuri de comentarii:
1. Comentariu pe o singură linie
În Swift, orice linie care începe cu două bare //este un comentariu cu o singură linie. Tot ce începe cu două bare //este ignorat de compilator.
Puteți găsi un exemplu simplu în partea de sus a locului de joacă:
//: Playground - substantiv: un loc unde oamenii se pot juca
Începe cu două bare oblice //și oferă o explicație semnificativă a fișierului ca „: Teren de joacă - substantiv: un loc unde oamenii se pot juca”.
Exemplul 1: Comentariu cu o singură linie
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Exemplul de mai sus conține două comentarii pe o singură linie:
// Exemplu de program // stochează 3.14 în variabila pi
2. Comentariu multiliniu
Dacă comentariul dvs. include mai multe linii, îl puteți închide în interior /*… */.
Comentariile cu mai multe linii încep cu o bară directă urmată de un asterisc ( /*) și se termină cu un asterisc urmat de o bară directă ( */). Totul între /*și */este ignorat de compilatorul rapid.
/ * Acesta este un comentariu pe mai multe linii. După ce scrieți un comentariu pe mai multe linii adăugați * urmând de / pentru a-l termina * /
Exemplul 2: comentariu pe mai multe linii
/* 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)
Exemplul de mai sus conține un comentariu pe mai multe linii.
/ * Valoarea pi codificată poate fi mai puțin precisă. Deci, puteți calcula folosind tipurile de date încorporate pentru o valoare mai precisă * /
Lucruri de amintit
Deși comentariile sunt semnificative pentru a înțelege mai bine intenția codului scris. Iată câteva lucruri pe care trebuie să le luați în considerare în timp ce îl scrieți:
- Nu atașați comentarii cu // pe multilinie, deși este valid și compilatorul ignoră aceste linii. În loc să îl închideți în comentariul cu mai multe linii.
/*… */
Exemplu:// Acesta este un comentariu. // Folosiți-l atunci când este necesar și precis
Modul de mai sus pentru a scrie comentariul este corect, dar nu este recomandat, deoarece trebuie să scrieți comentarii pe mai multe linii dacă comentariul este mai mare decât o linie. Cea mai bună modalitate de a scrie este utilizarea comentariului pe mai multe linii ca:/ * Acesta este un comentariu. Folosiți-l atunci când este necesar și precis * /
- Comentariul cu o singură linie poate fi scris într-o linie separată sau împreună cu codul în aceeași linie. Cu toate acestea, se recomandă utilizarea comentariilor într-o linie separată.
Exemplu:let pi = 3.14159 // stochează 3.14 în variabila pi
Acest mod de a scrie comentarii este valid. Dar este mai bine să scrieți comentariul într-o linie separată ca:// stochează 3.14 în variabila pi let pi = 3.14159
- Chiar dacă sunteți un singur dezvoltator într-o echipă și sunteți singurul care scrie codul, dacă este necomentat, veți avea dificultăți în încercarea de a-și înțelege scopul în program. Deci, utilizați-l cu precizie și furnizați o descriere semnificativă.
- Faceți comentariul foarte simplu și semnificativ.
- Nu scrieți comentarii inutile asupra codului dvs.
- În majoritatea cazurilor, utilizați comentarii pentru a explica „de ce”, mai degrabă decât „cum”.
