برنامه نویس های حرفه ای و افرادی که بصورت تیمی کار می کنند، به تمیزی و منظم بودن کدهای پروژه اهمیت زیادی می دهند تا سریع تر و بهینه تر کدنویسی کنند. یکی از روش های کد نویسی منظم، کامنت گذاری در پروژه است.

کامنت (Comment) چیست؟

تصور کنید با همکارتان در حال انجام یک پروژه برنامه نویسی هستید. از همکارتان میخواهید که کدهایی که نوشته است را در اختیار شما بگذارد تا شما ادامه کدزنی رو انجام بدید تا پروژه سریع تر به اتمام برسد.

اما مشکلی وجود دارد. شما نمی دانید هر بخش از کدها به چه دستوری مربوط است و چه کاری را دقیقا انجام میدهد. مجبور می شوید که صدها و یا حتی هزاران خط کد را بررسی کنید تا متوجه شوید همکارتان برنامه را چگونه نوشته است و هر بخش از پروژه چطور کار میکند. این باعث میشود سرعت کدنویسی بسیار پایین بیاید و ساعت ها وقت شما را بگیرد.

اینجاست که باید از کامنت (Comment) استفاده کرد. توی کامنت گذاری، میتونید توضیحاتی رو راجب کدهاتون بدید که مثلا این بخش اطلاعات کاربر رو میگیره یا این تابع، لگاریتم رو بدست میاره. شاید هم بخواید برای دیباگ (Debug) کردن، بخشی از کدهایی که نوشتید رو غیرفعال کنید. کامنت رو میتونید بین خطوط کدهای برنامه نویسی یا حتی درون خط کد برنامه نویسیتون (به شرط اینکه کامنت پس از پایان یافتن کد باشه) هم قرار بدید.

کامنت گذاری خوانایی کدهای شما رو بالا میبره. ولی تاثیری توی سرعت cpu و اجرای کدهاتون نداره و فقط متنیه که توی کامپایلر یا ادیتور به برنامه نویس نشون داده میشه.

کامنت گذاری در زبان های برنامه نویسی مختلف، متفاوته. توی این مطلب هم میخوایم کامنت گذاری در زبان های پایتون (Python)، جاوا (Java)، جاوا اسکریپت (JavaScript)، اچ تی ام ال (HTML) و پی اچ پی (PHP) رو آموزش بدیم.

1- پایتون (Python)

در زبان برنامه نویسی پایتون برای کامنت کردن یک خط، از علامت # (هَش) استفاده میشه و تمام چیزهایی که توی اون خط و بعد از هَش نوشته بشه، تبدیل به کامنت میشه و کامپایلر اون رو به عنوان کد برنامه نویسی تشخیص نمیده.

				
					#Python print("Y")
print("X")

print(2+2) #answer is 4

آموزش برنامه نویسی پایتون

اگر قصد کامنت کردن چند خط را دارید، میتونید از سه تا ”’ (کوتیشن) استفاده کنید. کوتیشن ها رو باید اول قبل و بعد متن یا کدی که میخواید کامنت بشه، قرار بدید.
حواستون باشه که این سه تا ‘کوتیشن’ رو با “دبل کوتیشن” اشتباه نگیرید.

				
					'''
www.ArvinAcademy.ir
Learn new ability
'''

# "!دبل کوتیشن این شکلیه"

2- جاوا (Java)

در زبان برنامه نویسی جاوا به سه روش می تونید، کامنت گذاری کنید. با گذاشتن دو // (اسلش)، هر چیزی که بعد ازآن نوشته شود، تبدیل به کامنت می شود.

				
					public static void main(String[] args) {  //I love Java
System.out.println("Hello Java");
}

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

اگر قصد کامنت کردن چند خط را دارید، در ابتدا */ (اسلش ستاره) قرار میدید و برای بستن کامنت هم از /* (ستاره اسلش) استفاده کنید.

				
					public class HelloWorld {
    /*
    www.ArvinAcademy.ir
    This is a multi-line comment
    */
    }

یک روش سومی هم برای کامنت کردن چند خط وجود داره به اسم کامنت مستندسازی (documentation comment)
برای ابتدای دستور این کامنت از **/ (اسلش ستاره ستاره) و برای پایان کامنت از دستور /* (ستاره اسلش) استفاده می شود.
این نوع کامنت برای ساخت مستندات و توضیحات رسمی جهت توابع کتابخانه ای/API ها بکار می رود. برای استفاده از این کامنت نیاز به ابزار JavaCode دارید.

ابزار JavaCode شما را قادر به برون ریزی کامنت های کد خود به فرمت HTML می کند.

				
					/**

* The class helps listens to the user request

* And output

* @version 8.9

* @author Nitish Singh

*/

3- جاوا اسکریپت (JavaScript)

در زبان جاوا اسکریپت برای کامنت کردن یک خط و یا چندین خط، مانند زبان جاوا عمل می کنیم. مثل زیر:

				
					function showPrimes(n) {
  nextPrime:
  for (let i = 2; i < n; i++) {

    // check if i is a prime number
    for (let j = 2; j < i; j++) {
      if (i % j == 0) continue nextPrime;
    }
    /*
    alert(i);
    debugging...
    */
  }
}

4- اچ تی ام ال (HTML)

در زبان نشانه گذاری HTML اگر میخواهید در یک خط کامنت بزارید، باید متن مورد نظرتون رو داخل تگ <– comment –!> و به جای comment قرار بدید.

				
					<html>
  <head>
      
    <title> آموزش برنامه نویسی با آروین آکادمی </title>
    <!-- عنوان سایت را در این بخش بنویسید -->
    
  </head>
</html>

اگر قصد کامنت کردن چند خط را دارید، باز هم از تگ <—-!> استفاده می کنیم. با این تفاوت که –!> را در خط اول و <– را در خط آخر قرار میدیم.

				
					<!DOCTYPE html>
<html>
<head>
<title>Multiline Comments</title>
</head>
<body>
<!-- 
This is a multiline comment and it can
span through as many as lines you like.
 -->
<p>Document content goes here.....</p>
</body>
</html>

توی HTML می توانید از کامنت شرطی هم استفاده کنید. کامنت های شرطی فقط در مرورگرهای IE کار خواهند کرد. توسط این نوع کامنت، دستورالعمل خاصی را برای نسخه های مختلف IE تعیین کنید.
شرط خود را درون تگ <[]–!> مانند زیر قرار می دهید و برای پایان آن از تگ <–[endif]!> استفاده کنید.

				
					<!--[if IE 9]>
    .... مانند اکسپلور اجرا می شود IE این تگ فقط در مرورگرهای ....
<![endif]-->

5- پی اچ پی (PHP)

کامنت گذاری در زبان PHP هم مانند زبان جاوا و جاوا اسکریپت انجام می شود.

				
					<?php   //Simple PHP code
  echo "<p>Hello World!</p>";
   /*
   This is a multi-line comment block
   that spans over
   multiple lines
   */
   echo "<p>I am learning PHP!</p>";
   echo "<p>This is my first program!</p>";
?>