در این بخش از مقاله آموزش کاتلین به بررسی روش درج توضیح یا کامنت در کاتلین می‌پردازیم و علت استفاده از آن را شرح می‌دهیم.
کامنتها بخشی از برنامه هستند که به منظور درک بهتر کد چه برای خود برنامه‌نویس و چه افراد دیگری که کد را می‌خوانند مورد استفاده قرار می‌گیرند. کامنتها از سوی کامپایلر کاتلین به طور کامل نادیده گرفته می‌شوند. همانند جاوا دو روش برای درج کامنت در کاتلین وجود دارد:
- /* … */
- // ….
روش سنتی درج کامنت
برای درج کامنت‌های چندخطی که در خطوط مختلفی نوشته می‌شوند، باید از نمادهای /* … */ استفاده کنید. کامپایلر کاتلین هر چیزی را که بین /* و */ قرار داشته باشد، نادیده می‌گیرد. به مثال زیر توجه کنید:
/* 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 یا تبیین سناریوهایی که از یک تکنیک به جای تکنیک‌های دیگر برای حل مسئله استفاده کنیم، هیچ اشکالی ندارد. در اغلب موارد باید از کامنتها به منظور توضیح چرایی و نه چگونگی کد استفاده کنیم.
