W tym artykule dowiesz się o komentarzach Swift, dlaczego i jak ich używać.
Komentarz to czytelne dla programisty wyjaśnienie lub adnotacja w kodzie źródłowym programu. Jest ignorowany przez kompilator podczas kompilacji kodu.
Komentarze są przeznaczone dla osoby czytającej kod, aby lepiej zrozumieć przeznaczenie i funkcjonalność programu. Może to być pomocne podczas pracy w zespole, aby wyjaśnić cel kodu dla innych członków zespołu lub podczas pracy tylko z nim może służyć jako przypomnienie o posiadaniu.
Szybki komentarz i jego rodzaje
W skrócie są dwa rodzaje komentarzy:
1. Komentarz jednowierszowy
W języku Swift każda linia zaczynająca się od dwóch ukośników //jest komentarzem w jednym wierszu, a kompilator ignoruje wszystko, co zaczyna się od dwóch ukośników //.
Na górze placu zabaw znajdziesz prosty przykład:
//: Playground - rzeczownik: miejsce, w którym ludzie mogą się bawić
Zaczyna się od dwóch ukośników //i zawiera znaczące wyjaśnienie pliku jako „: Playground - rzeczownik: miejsce, w którym ludzie mogą się bawić”.
Przykład 1: Komentarz jednowierszowy
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Powyższy przykład zawiera dwa jednowierszowe komentarze:
// Przykładowy program // przechowuje 3,14 w zmiennej pi
2. Komentarz wielowierszowy
Jeśli Twój komentarz zawiera wiele wierszy, możesz umieścić go w środku /*… */.
Komentarze wielowierszowe rozpoczynają się od ukośnika, po którym następuje gwiazdka ( /*) i kończą się gwiazdką, po której następuje ukośnik ( */). Wszystko pomiędzy /*i */jest ignorowane przez szybki kompilator.
/ * To jest komentarz wielowierszowy. Po napisaniu komentarza wielowierszowego dodaj * następujące po /, aby go zakończyć * /
Przykład 2: komentarz wielowierszowy
/* 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)
Powyższy przykład zawiera komentarz wielowierszowy.
/ * Wartość pi zakodowana na stałe może być mniej dokładna. Możesz więc obliczyć, używając wbudowanych typów danych, aby uzyskać dokładniejsze wartości * /
Rzeczy do zapamiętania
Chociaż komentarze są znaczące, aby lepiej zrozumieć cel napisanego kodu. Oto rzeczy, które musisz wziąć pod uwagę podczas pisania:
- Nie otaczaj komentarzy znakiem // na multilinii, chociaż jest on prawidłowy i kompilator ignoruje te wiersze. Zamiast tego umieść go w komentarzu wielowierszowym
/*… */
Przykład:// To jest komentarz. // Używaj go, gdy jest to konieczne i precyzyjnie
Powyższy sposób pisania komentarza jest poprawny, ale nie jest zalecany, ponieważ musisz pisać komentarze wielowierszowe, jeśli komentarz jest większy niż jedna linia. Lepszym sposobem pisania jest użycie komentarza wielowierszowego jako:/ * To jest komentarz. Używaj go w razie potrzeby i precyzyjnie * /
- Komentarz jednowierszowy można zapisać w osobnym wierszu lub wraz z kodem w tym samym wierszu. Zaleca się jednak umieszczanie komentarzy w osobnym wierszu.
Przykład:niech pi = 3,14159 // przechowuje 3,14 w zmiennej pi
Ten sposób pisania komentarzy jest ważny. Ale lepiej jest napisać komentarz w osobnej linii jako:// przechowuje 3,14 w zmiennej pi niech pi = 3,14159
- Nawet jeśli jesteś pojedynczym programistą w zespole i tylko ty piszesz kod, jeśli nie jest on skomentowany, będziesz miał trudności z określeniem jego przeznaczenia w programie. Dlatego używaj go precyzyjnie i podaj zrozumiały opis.
- Niech komentarz będzie bardzo prosty i zrozumiały.
- Nie pisz niepotrzebnych komentarzy na temat swojego kodu.
- W większości przypadków użyj komentarzy, aby wyjaśnić „dlaczego” zamiast „jak”.
