کامنت ها (Swift Comments)
اینجا با «کامنت سوئیفت» آشنا می شوی. «کامنت (Comment)» توضیح کنار کد است. برنامه آن را اجرا نمی کند. پس بهتر می فهمی کد چه می گوید. مثل یادداشت کنار تمرین ریاضی.
انواع کامنت سوئیفت
سوئیفت سه نوع کامنت دارد: تک خطی، چندخطیِ تو در تو، و مستندسازی. هرکدام جای خودشان مفید هستند.
تک خطی و چندخطی
// برای تک خطی است. همچنین /* ... */ چندخطی است و می تواند تو در تو باشد. این کمک می کند بخش های بزرگ را موقت خاموش کنی.
// این یک کامنت تک خطی است
print("Hello")
/* این یک
کامنت چندخطی است */
print("Swift")
/* کامنت های تو در تو مجازند:
/* inner */
*/
نکته: از چندخطیِ تو در تو زمانی استفاده کن که داخل بخشی کامنت داری و می خواهی کل بخش را هم غیرفعال کنی.
کامنت مستندسازی (Documentation)
با /// قبل از اعلان ها، توضیح رسمی می نویسی. ابزارها می توانند این متن را به مستند تبدیل کنند. برای «پارامتر (Parameter)» و «برگشت (Return)» هم توضیح می دهی.
/// مجموع دو عدد صحیح را برمی گرداند.
/// - Parameters:
/// - a: عدد اول
/// - b: عدد دوم
/// - Returns: حاصل جمع a و b
func add(_ a: Int, _ b: Int) -> Int {
return a + b
}
print(add(2, 3))
گام های عملی
- روی یک خط، کامنت تک خطی بنویس.
- یک بلوک چندخطی اضافه کن.
- برای یک تابع، کامنت مستند با
///بنویس.
برای یادگیری بیشتر، صفحه سینتکس و چاپ اعداد را ببین. سپس به متغیرها برو تا توضیحات را در کد واقعی تمرین کنی.
جمع بندی سریع
//تک خطی است و سریع./* ... */چندخطی و تو در تو است.///برای مستندسازی رسمی است.- کامنت خوب، فهم کد را ساده می کند.