کامنت ها در برنامه نویسی کاتلین

کامنت ها در برنامه نویسی کاتلین

در درس ششم از آموزش برنامه نویسی سایت سورس باران، با کامنت ها در برنامه نویسی کاتلین ، چرایی و نحوه استفاده از آنها آشنا خواهید شد.

در برنامه نویسی، کامنت ها بخشی از برنامه است که برای درک کد توسط برنامه نویس ها در نظر گرفته شده است. کامنت ها به طور کلی توسط کامپایلر برنامه کاتلین کاملاً نادیده گرفته می شوند.

مشابه جاوا، در کاتلین دو نوع کامنت وجود دارد؛

/* ... */

// ....

کامنت   / * … * / در کاتلین

این یک کامنت چند خطی است. کامپایلر کاتلین از / * تا * / نادیده می گیرد. مثلا،

/* This is a multi-line comment.
 * The problem prints "Hello, World!" to the standard output.
 */
fun main(args: Array<String>) {

   println("Hello, World!")
}

از ابن کامنت برای مستند سازی کد کاتلین (KDoc) با اندکی تغییر نیز استفاده می شود. کامنت های KDoc با / ** شروع می شود و با * / به پایان می رسد.

کامنت پایان خط // در کاتلین

کامپایلر از // تا پایان خط همه چیز را نادیده می گیرد. مثلا،

// Kotlin Hello World Program
fun main(args: Array<String>) {

   println("Hello, World!")      // outputs Hello, World! on the screen
}

کد بالا شامل دو کامنت پایان خط است:

// Kotlin Hello World Program

و

// outputs Hello, World! on the screen

از کامنت ها به روش صحیح استفاده کنید

کامنت ها نباید جایگزین روشی برای توضیح کد اشتباه نوشته شده به انگلیسی باشد. یک کد با ساختار مشخص و قابل خواندن بنویسید و سپس از کامت هااستفاده کنید.

برخی معتقدند که کد باید واضح و گویا باشد و از کامنت ها در برنامه نویسی کاتلین استفاده نشود. با این حال، دیدگاه های دیگری نیز وجود دارد، مثلا استفاده از کامنت ها برای توضیح الگوریتم های پیچیده ، regex یا سناریوهایی که برای حل مسئله یک روش را به جای دیگری (برای مراجعه در آینده) انتخاب کرده اید، مشکلی ندارد.

در بیشتر موارد، برای توضیح “چرا” به جای “چگونه” از کامنت ها استفاده کنید.

منبع.

لیست جلسات قبل آموزش برنامه نویسی کاتلین

1. معرفی کاتلین،  Kotlin Hello World – اولین برنامه کاتلین
2. انواع متغیرهای پایه در کاتلین
3. عملگرهای برنامه نویسی کاتلین
4. تبدیل نوع در برنامه نویسی کاتلین
5. عبارت ها، گزاره ها و بلوک ها در برنامه نویسی کاتلین