استارت‌آپ و کارآفرینی

آموزش قدم به قدم جاوا – قسمت سوم

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

کامنت‌ها (Comments)

از کامنت برای افزودن توضیحات به قسمتی از کد استفاده می‌شود. این توضیحات در فرآیند کامپایل برنامه و به طور کلی در برنامه هیچ تاثیری ندارند و تنها کاربرد آ‌ ها ارائه توضیحاتی درباره قسمتی از کد است.

به دو دلیل اصلی زیر باید کدها را کامنت‌گذاری کرد:

  1. فرض کنید برنامه‌ای با ۵۰۰۰ خط کد نوشتید و بعد از مثلا ۶ ماه دوباره قصد دارید قسمت‌هایی از برنامه خود را تغییر دهید. مسلما بعضی از قسمت‌های کد خود را با اینکه خودتان آن را نوشتید متوجه نمی‌شوید چون مدت زیادی گذشته و بیشتر آن‌ها از حافظه شما رفته است. اگر کد خود را به شکل مناسب کامنت‌گذاری کرده باشید با این مشکل مواجه نخواهید شد!
  2. فرض کنید برنامه‌ای نوشتید و قرار است کدهای آن را به یک برنامه‌نویس دیگر بدهید تا آن را مطالعه کند یا قسمت‌هایی از آن را تغییر دهد. کدی که شما نوشتید برای خودتان کاملا قابل فهم است اما برای برنامه‌نویس دیگر الزاما اینطور نیست، چون در جریان نوشتن برنامه شما نبوده است. شما باید کد خود را کامنت‌گذاری کنید تا برنامه‌نویسان دیگر بفهمند که مثلا یک قطعه کد دقیقا چه کار می‌کند و هدف از نوشتن این قطعه کد چه بوده است.

کامنت‌گذاری صحیح و مناسب یکی از مهم‌ترین مهارت‌هایی است که هر برنامه‌نویس باید با آن آشنا باشد.

انواع کامنت در جاوا

کامنت‌ها در جاوا را می‌توان به سه دسته تقسیم کرد:

کامنت‌های تک‌خطی (Single Line Comments)

از این نوع کامنت‌ها برای نوشتن توضیحات یک خطی استفاده می‌شود و شکل کلی آن به صورت زیر است:

// توضیحات

مثال:

public class Main {

	public static void main(String[] args) {
		System.out.println("Hello!"); // Say hello to the user
		System.out.println("What's your name?"); // Ask the user's name
	}

}

همانطور که دیدید برای هر دو دستور چاپ خود یک خط توضیح نوشتیم. اگرچه نمی‌توان اهمیت کامنت‌ها را در دو خط کد نشان داد!

کامنت‌های چند خطی (Multiline Comments)

تفاوت این نوع کامنت با نوع قبلی این است که می‌توان در یک کامنت چند خط متن نوشت. شکل کلی آن به صورت زیر است:

/*
	خط اول
	خط دوم و ...
*/

مثال:

public class Main {

	public static void main(String[] args) {
		/*
		 در کد زیر دو متغیر تعریف کرده			
و به آن ها مقدار داده ایم			
		 */
		int x = 3;
		int y = 2;
	}

}

کامنت‌های مستندات (Documentation Comments)

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

مرتبط:

آموزش قدم به قدم جاوا – قسمت اول

آموزش قدم به قدم جاوا – قسمت دوم

5 نظرات
  1. علی می گوید

    خوبه

  2. Ali می گوید

    مچکر
    اگه فاصله انتشار درس ها کمتر باشه، خیلی خوب میشه
    بازم ممنون

    1. مصطفی نصیری می گوید

      به دلیل نظم در انتشار معمولا با فاصله ی مشخصی مطالب منتشر میشن البته چون این قسمت کوتاه بود قسمت بعدی فردا منتشر خواهد شد. از طرفی آماده کردن قسمت های طولانی زمان بر هست اما تمام تلاشم رو میکنم تا فاصله انتشار به حداقل برسه.
      موفق باشید

  3. جام تراس می گوید

    جالبه خیلی این کامنت‌ها در هنگام نوشتن کد به برنامه نویس کمک می‌کند.

  4. وحید می گوید

    اگه مطالب پیشرفته در مورد لاراول هم بگذارید عالی میشه.♥
    ممنون

ارسال یک پاسخ

آدرس ایمیل شما منتشر نخواهد شد.