Comments در جاوا

مقدمه

در برنامه‌نویسی، گاهی لازم است توضیحاتی را در میان کدهای خود بنویسیم تا مشخص شود هر بخش از برنامه چه کاری انجام می‌دهد. این توضیحات را در زبان Java با نام Comment می‌شناسیم.

کامنت‌ها بخشی از برنامه هستند که توسط کامپایلر اجرا نمی‌شوند و در نتیجه هیچ تأثیری بر عملکرد برنامه ندارند. با استفاده از کامنت‌ها می‌توانیم کد را برای خودمان یا سایر برنامه‌نویسان قابل فهم‌تر کنیم.

کامنت‌گذاری مناسب، به‌خصوص در پروژه‌های بزرگ، اهمیت زیادی دارد؛ زیرا پس از گذشت زمان ممکن است بخشی از کد را فراموش کنیم و توضیحات موجود در کامنت‌ها به درک سریع‌تر آن کمک کنند.

کامنت چیست؟

Comment یا توضیح، متنی است که برنامه‌نویس داخل کد قرار می‌دهد تا درباره عملکرد یا هدف یک بخش از برنامه توضیح دهد.

کامنت توسط کامپایلر نادیده گرفته می‌شود؛ بنابراین اگر یک کامنت را تغییر دهیم یا حذف کنیم، در حالت عادی نتیجه اجرای برنامه تغییر نخواهد کرد.

کامنت یک‌خطی

برای ایجاد کامنت یک‌خطی در Java از دو علامت اسلش // استفاده می‌کنیم. هر چیزی که بعد از این علامت در همان خط قرار بگیرد، توسط کامپایلر به‌عنوان کامنت در نظر گرفته می‌شود.

// This is a comment
System.out.println("Hello World!");

در مثال بالا، خط اول یک کامنت است و اجرا نمی‌شود؛ اما خط دوم توسط برنامه اجرا خواهد شد.

Hello World!

نوشتن کامنت فارسی

کامنت‌ها می‌توانند به زبان فارسی نیز نوشته شوند. این موضوع هیچ مشکلی برای اجرای برنامه ایجاد نمی‌کند.

// This program displays a message
System.out.println("Hello");

در یک پروژه واقعی می‌توان توضیحات را به زبان فارسی یا انگلیسی نوشت؛ مهم این است که کامنت‌ها واضح، کوتاه و مرتبط با کد باشند.

قرار دادن کامنت در کنار کد

می‌توان کامنت را در همان خطی که کد قرار دارد نیز نوشت. در این حالت، کامپایلر بخش بعد از // را نادیده می‌گیرد.

System.out.println("Hello"); // Display a message

در این مثال، دستور System.out.println() اجرا می‌شود، اما عبارت // Display a message صرفاً یک توضیح است.

Hello

کامنت چندخطی

اگر بخواهیم توضیحی را در چند خط بنویسیم، از کامنت چندخطی استفاده می‌کنیم. کامنت چندخطی با /* شروع و با */ پایان پیدا می‌کند.

/*
 This is a multi-line comment.
 It can contain several lines.
*/

System.out.println("Hello World!");

تمام متنی که بین /* و */ قرار داشته باشد، کامنت محسوب می‌شود.

Hello World!

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

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

// Store the user's age
int age = 25;

// Display the age
System.out.println(age);

در این مثال، کامنت اول توضیح می‌دهد که متغیر age برای ذخیره سن کاربر استفاده شده است و کامنت دوم هدف دستور خروجی را مشخص می‌کند.

25

استفاده از کامنت برای غیرفعال کردن کد

یکی دیگر از کاربردهای مفید کامنت، غیرفعال کردن موقت یک یا چند دستور است. برای مثال، اگر یک خط کد را با // شروع کنیم، آن خط دیگر اجرا نخواهد شد.

System.out.println("First");
 // System.out.println("Second");
System.out.println("Third");

در این مثال، دستور دوم غیرفعال شده است و بنابراین فقط دو پیام اول و سوم نمایش داده می‌شوند.

First
Third

تفاوت کامنت یک‌خطی و چندخطی

نکات مهم در کامنت‌گذاری

• کامنت باید هدف مشخصی داشته باشد و توضیح آن واضح باشد.
• از نوشتن کامنت‌های غیرضروری و بسیار زیاد خودداری کنید.
• برای توضیح یک خط کوتاه می‌توانید از // استفاده کنید.
• برای توضیحات چندخطی می‌توانید از /* … */ استفاده کنید.
• کامنت‌ها توسط کامپایلر اجرا نمی‌شوند.
• می‌توان از کامنت برای غیرفعال کردن موقت بخشی از کد استفاده کرد.
• کامنت خوب باید به فهم بهتر کد کمک کند، نه اینکه خواندن کد را دشوارتر کند.

یک مثال کامل

در مثال زیر چند نوع کامنت را در یک برنامه مشاهده می‌کنید:

// Create a variable
String name = "Ali";

/*
Display the user's name
on the screen
*/
System.out.println("Name: " + name);

Name: Ali

تمرین

یک برنامه ساده در Java بنویسید که:

1. یک متغیر از نوع String برای نام ایجاد کند.
2. یک متغیر از نوع int برای سن ایجاد کند.
3. برای هر متغیر یک کامنت توضیحی بنویسد.
4. نام و سن را با استفاده از System.out.println() نمایش دهد.
5. یکی از دستورات خروجی را به‌صورت موقت با استفاده از // غیرفعال کند.

جمع‌بندی

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

یاد گرفتیم که برای کامنت یک‌خطی از // و برای کامنت چندخطی از /* … */ استفاده کنیم. همچنین دیدیم که کامنت‌ها می‌توانند برای توضیح کد یا غیرفعال کردن موقت بخشی از برنامه نیز کاربرد داشته باشند.