در برنامه نویسی پیش خواهد آمد زمانیکه شما بازگشتی به عقب دارید و می خواهید کدی را که مثلا 3 سال قبل نوشته اید را بازسازی نموده یا مرور نمایید و یا اینکه در یک پروژه گروهی شما شرکت نموده اید و می خواهید یک بخش از کدی را که همکار شما نوشته است اصلاح نمایید در اینگونه موارد اگر بخواهید به کدهای خام یک فرد یا حتی خودتان نگاه بیندازید و از آن سر در بیاورید به طور حتم درک کد برایتان مشکل خواهد بود.
خب چاره چیست؟
استفاده از توضیحات درون کد.
توضیحات درون کد برای درک بهتر از یک کد می باشد. توضیحات فقط در پروژه های بزرگ و یا تجاری استفاده نمی شوند شما می توانید در هر برنامه ای که می نویسید حتی آنهایی که یک خط کد دارند از توضیحات استفاده نمایید.
در دلفی می توان توضیحات را به فارسی نیز نوشت.
توضیحات در دلفی به دو دسته تقسیم می گردند:
1- توضیحات تک خطی
2- توضیحات چند خطی
در توضیحات تک خطی شما از علامت // استفاده می نمایید که دقیقا مشابه با توضیحات درون برنامه های شبه C می باشد. این توضیحات از این علامت شروع شده و تا انتهای خط ادامه دارد. ( یعنی خط بعدی شامل توضیحات نمی گردد.)
مثال:
// محاسبه ی دلتا در سهمی
delta := b * b - 4 * a * c;
x1 = (-b + sart(delta)) / (2 * a); // این خط ریشه ی اول را محاسبه می کند
در قطعه کد بالا می بینید که اولین خط کلا توضیحات است.
دومین خط یک محاسبه می باشد.
و سومین خط از ابتدا تا // یک فرمول و از // تا انتهای خط توضیحات است.
توضیحات چند خطی دو نوع می باشد که برخلاف توضیحات تک خطی از یک جفت علامت استفاده می گردد که ابتدا و انتهای توضیحات را نشان می دهند اولین نوع از توضیحات چند خطی علامتهای (* و *) می باشند و دومین نوع { و } هستند. هر چیزی که بین (* و *) قرار گیرد و یا بین { و } باشد به عنوان توضیح در نظر گرفته می شود.
مثال:
readln(a, b, c);
{در این بخش کنترل می گردد که طبق قانون اضلاع مثلث آیا سه مقدار وارد شده می توانند
اضلاع یک مثلث باشند یا خیر}
if (a + b <= c) or (a + c <= b) or (b + c <= a) then
writeln('false');
در قطعه کد بالا نیز توضیحات چند خطی را مشاهده می نمایید.
توضیحات از طرف کامپایلر نادیده گرفته می شود و صرفا جهت راهنمایی و افزایش خوانایی کدها برای برنامه نویسان کاربرد دارد.