الـتعليقات في التعليمات البرمجية

أثناء قراءة أمثلة التعليمات البرمجية التي غالباً ما تواجه رمز التعليق ('). يخبر هذا الرمز برنامج التحويل البرمجيVisual Basic إلى تجاهل النص الذي يليه, أو الـتعليق. الـتعليقات هي ملاحظات تعليلية مختصرة تمت إضافتها إلى التعليمات البرمجية لصالح الذين يقرؤنها.

تدريب عملي برمجي جيد لبدء كل الإجراءات مع تعليق مختصر يصف مواصفات الوظيفية للإجراء (ماذا يفعل). هذه الفائدة خاصة لك و فائدة لأي شخص آخر قام بفحص التعليمات البرمجية. يجب فصل تفاصيل التنفيذ (كيفي يقوم الإجراء به) من التعليقات التي تصف الصفات المميزة الوظيفية. عند تضمين تفاصيل التطبيق في الوصف, تذكر تحديثها عندما تقوم بتحديث الدالة.

الـتعليقات يمكن أن تتبع كشف على نفس السطر أو تشغل السطر بالكامل. كلاهما موضح في التعليمة البرمجية التالية.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

إذا تطلب تعليقك أكثر من خط واحد, استخدم رمز التعليق على كل سطر كما هو موضح في المثال التالي.

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

إرشادات التعليق

يوفر الجدول التالي إرشادات عامة حول ما هي أنواع التعليقات التي يمكن أن تسبق مقطع من تعليمات برمجية. هذه هي الاقتراحات; Visual Basic لا يفرض قواعد لإضافة تعليقات. كتابة ما يعمل بشكل أفضل ، لك و لكل شخص آخر الذي يقرأ التعليمات البرمجية الخاصة بك.

نوع الـتعليق	وصف التعليق
الغرض	وصف ما يقوم به الإجراء (ليس كيفية القيام به)
افتراضات	يسرد كل متغير خارجي, عنصر تحكم, أو فتح ملف, أو عنصر آخر يتم الوصول إليها من قبل الإجراء
التأثيرات	يسرد كل متغير خارجي متأثر, عنصر تحكم، أو ملف و التأثير الذي يملكه (فقط إذا كان غير واضحة)
الإدخالات	تحديد غرض الوسيطة
يقوم بإرجاع	توضح هذه المقالة القيم التي تم إرجاعها بواسطة الاجراء

تذكر النقاط التالية:

• يجب أن يسبق كل تعريف متغير مهم تعليق يصف استخدام المتغير الذي يتم تعريفه.

• الـمتغيرات, عناصر التحكم والإجراءات يجب أن تكون مسمية تسمية واضحة بما يكفي بحيث تكون التعليقات فقط من أجل تفاصيل التطبيق المعقدة.

• لا يمكن لتعليقات اتباع تسلسل متابعة خط على نفس السطر.

يمكنك إضافة أو إزالة رموز التعليق لقطع من التعليمات البرمجية عن طريق تحديد واحد أو أكثر من سطور التعليمات البرمجية واختيار الـتعليق () و ازالة التعليق () الأزرار على شريط الأدوات تحرير .

ملاحظة

يمكنك أيضاً إضافة التعليقات إلى التعليمات البرمجية عن طريق اضافة الكلمة الأساسية REM قبل نص. ومع ذلك، ' الرمز و الـتعليق/ازالة التعليقالأزرار تكون أسهل في استخدام وتتطلب مساحة وذاكرة أقل.

راجع أيضًا:

المرجع

عبارة Vsual Basic) REM)

موارد أخرى

بنية البرنامج و اصطلاحات التعليمات البرمجية