نوشتن توضیحات برای کدها

 

بیشتر اسنادی که شما اجرا خواهید کرد در توضیحات به هر اندازه که می توانید,ارائه دهید.توضیحات به شما و دیگران که کد شما را می خوانند,در فهم اینکه شما جه کاری انجام خواهید داد کمک می کند.

توضیحات,هنگام اجرای برنامه توسط کامپایلر خوانده نمی شوند.یعنی شما آن ها را در گفتگوی روزانه نوشته اید.در این دو روش معمول برای قرار دادن توضیحات  در برنامه تان وجود دارد,برای توضیحاتی که یک خطی هستند با دو forward slashes مانند// آغاز کنید.

به مثال زیر توجه کنید:

// include the first library
#include <iostream>
using namespace std;
 
int main()
{
// Here is a simple sentence
cout << "Hi, this is my program!";
return 0;
}
// The end of my program

می توانید تعداد خط زیادی توضیحات در برنامه تان قرار دهید.برای اینکار توضیح هر خط را با دو slash آغاز کنید.روش دیگر آغاز پاراگراف توضیح با /* و پایان دادان آن با */ می باشد.

در اینجا نسخه ی دیگری از برنامه ی توضیح داده شده ی ما را می بینید:

 

// The exo.cpp program
// Include the ostream library
#include <iostream>
using namespace std;
 
int main()
{
/* Here is a simple sentence that I want to display
when the program starts. It doesn't do much.
I am planning to do more stuff in the future. */
 
cout << "Hi, this is my program!";
return 0;
}
// The end of my program

منبع: www.functionx.com