توضیحات (Comments)

توضیحات (Comments) متن های راهنما داخل کد هستند. آن ها کد را خواناتر می کنند. همچنین هنگام تست، می توانند اجرای بخش ها را متوقف کنند. در C++ دو مدل داریم: تک خطی و چندخطی.

توضیحات تک خطی (Single-line)

با دو اسلش // شروع می شوند. بقیه خط نادیده گرفته می شود.

#include <iostream>
using namespace std;

int main() {
  // This is a comment
  cout << "Hello World!";
  return 0;
}

می توانی آخر خط کد هم بنویسی. مثل برچسب کنار تکلیف مدرسه.

#include <iostream>
using namespace std;

int main() {
  cout << "Hello World!"; // This is a comment
  return 0;
}

نکته: توضیح اجرا نمی شود. فقط برای انسان هاست.

توضیحات چندخطی (Multi-line)

با /* شروع و با */ تمام می شود. متن میانشان نادیده می شود.

#include <iostream>
using namespace std;

int main() {
  /* The code below prints Hello World!
     to the screen, and it is amazing */
  cout << "Hello World!";
  return 0;
}

نکته: کوتاه ها را با // بنویس. متن های بلند را چندخطی کن.

تمرین سه مرحله ای

1. یک توضیح تک خطی بالای cout بگذار.
2. یک توضیح چندخطی قبل از main بنویس.
3. برنامه را اجرا کن و خروجی را چک کن.

هشدار: فراموش نکن */ را ببندی. وگرنه خطا می گیری.

جمع بندی سریع

• // برای یک خط است.
• /* ... */ برای چند خط است.
• توضیح اجرا نمی شود.
• خوانایی یعنی وقت کمتر برای فهم کد.

برای خروجی های تمیز، صفحه خطوط جدید C++ را ببین. همچنین چاپ متن را در خروجی C++ مرور کن. اگر نیاز داشتی، همین صفحه توضیحات C++ را دوباره مطالعه کن.