Bu makalede, Swift yorumlarını, neden ve nasıl kullanılacağını öğreneceksiniz.
Yorum, bir programın kaynak kodunda yer alan programcı tarafından okunabilen bir açıklama veya ek açıklamadır. Kod derlendiğinde derleyici tarafından yok sayılır.
Yorumlar, programın amacını ve işlevselliğini daha iyi anlamak için kodu okuyan kişiye yöneliktir. Bir ekip üzerinde çalışırken diğer ekip üyeleri için kodun amacını açıklığa kavuşturmak yararlı olabilir veya yalnızca çalışırken bu, sahip olmak için bir hatırlatma işlevi görebilir.
Swift Yorum ve Türleri
Swift'de iki tür yorum vardır:
1. Tek Satır Yorum
Swift'de iki eğik çizgiyle başlayan herhangi bir satır //tek satırlık bir yorumdur. İki eğik çizgiyle başlayan her //şey derleyici tarafından yok sayılır.
Oyun alanının tepesinde basit bir örnek bulabilirsiniz:
//: Playground - isim: insanların oynayabileceği bir yer
İki eğik çizgiyle başlar //ve dosyanın ": Oyun alanı - isim: insanların oynayabileceği bir yer" şeklinde anlamlı bir açıklamasını sağlar.
Örnek 1: Tek Satır Yorum
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Yukarıdaki örnek iki tek satırlık açıklama içerir:
// Örnek program // 3.14'ü pi değişkeninde depolar
2. Çok Satırlı Yorum
Yorumunuz birden fazla satır içeriyorsa, içine yazabilirsiniz /*… */.
Çok satırlı yorumlar, eğik çizgi ile başlar, ardından bir yıldız işareti ( /*) gelir ve bir yıldız işaretiyle ve ardından eğik çizgi ( ) ile biter */. Aradaki her şey /*ve */hızlı derleyici tarafından göz ardı edilir.
/ * Bu çok satırlı bir yorumdur. Çok satırlı yorum yazdıktan sonra * / ile sonlandırmak için * /
Örnek 2: Çok satırlı yorum
/* 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)
Yukarıdaki örnek, çok satırlı bir yorum içerir.
/ * Sabit kodlanmış pi değeri daha az doğru olabilir. Böylece, daha doğru değer için yerleşik veri türlerini kullanarak hesaplama yapabilirsiniz * /
Hatırlanacak şeyler
Yazılan kodun amacını daha iyi anlamak için yorumlar anlamlı olsa da. Yazarken göz önünde bulundurmanız gereken şeyler şunlardır:
- Geçerli olmasına ve derleyicinin bu satırları yok saymasına rağmen, açıklamaları çok satırlı üzerinde // ile sarmayın. Bunun yerine onu çok satırlı yorumun içine alın
/*… */
Örnek:// Bu bir yorumdur. // Gerektiğinde ve tam olarak kullanın
Yorum yazmanın yukarıdaki yolu doğrudur, ancak yorum birden fazla satırdan büyükse çok satırlı yorumlar yazmanız gerektiğinden önerilmez. Yazmanın daha iyi yolu, çok satırlı yorumu şu şekilde kullanmaktır:/ * Bu bir yorumdur. Gerektiğinde ve tam olarak kullanın * /
- Tek satır yorum ayrı bir satırda veya aynı satırda kodla birlikte yazılabilir. Ancak yorumların ayrı bir satırda kullanılması tavsiye edilir.
Misal:let pi = 3.14159 // 3.14'ü pi değişkeninde depolar
Bu şekilde yorum yazmak geçerlidir. Ancak aşağıdaki gibi ayrı bir satırda yorum yazmak daha iyidir:// 3.14'ü pi değişkeninde saklar let pi = 3.14159
- Bir takımda tek bir geliştirici olsanız ve kodu yazan tek kişi siz olsanız bile, yorum yapılmamışsa, programdaki amacını anlamaya çalışırken zorlanacaksınız. Bu nedenle, onu tam olarak kullanın ve anlamlı bir açıklama sağlayın.
- Yorumu çok basit ve anlamlı yapın.
- Kodunuza gereksiz yorumlar yazmayın.
- Çoğu durumda, 'nasıl' yerine 'neden'i açıklamak için yorumları kullanın.
