دورة في لغة c (الدرس الرابع) .. التعليقات

بسم الله الرحمن الرحيم
السلام عليكم ورحمة الله وبركاته

التعليقات (comments)

ما هي التعليقات؟ comments

التعليقات هي عبارة عن جمل يكتبها المبرمج عند كتابة البرنامج لشرح نقطة معينة أو وصف البرنامج وهذه الجمل يتجاهلها برنامج المترجم.

ما هي اللغة المستخدمة في كتابة التعليقات؟
تستطيع كتابة التعليقات بأي لغة تريدها سواء الفرنسية أو الإنجليزية أو حتى
العربية ، لأني قلت سابقا بأن التعليقات سوف يتجاهلها البرنامج، لذلك مثلا
تستطيع كتابة اسمك !!

ما هي الفائدة من كتابة التعليقات؟
حينما تكتب برنامجا لك فقط دون أن يراه الغير ، فإنك ربما تقول لنفسك بأنك
لن تحتاج إلى كتابة أي تعليق لأنك أنت صاحب البرنامج لذلك تستطيع فهمه دون
أن تكون هنالك تعليقات تشرح البرنامج ، ولكني أسألك سؤال ، تخيل بأنك كتبت
البرنامج ومرت عليه شهور ولم تراه ثم بعدها نظرت إلى برنامجك فهل سوف
تتذكره مباشرة؟
ربما إذا كان برنامجا سهلا فلن تحتاج لأي شيء يذكرك به ، ولكن تخيل بأنه
كان برنامجا معقدا ويحتوي على دوال كثيرة فإنك سوف تضيع وقتك في فهم
البرنامج مرة أخرى .

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

هل تصدق إذا قلت لك بأن البرامج الناجحة هي البرامج التي تحتوي على تعليقات ؟؟
سوف تكتشف هذا إذا إرسل لك يوما برنامجا بدون أي تعليق ، فانظر كيف سيضيع وقتك وأنت تحاول أن تفهم الغرض من البرنامج.

أود إضافة تعليقات ولكني لا أعلم كيف أضيفها وكم أضيف من التعليقات؟

سؤال مهم…………وإجابته تعتمد على نوع البرنامج الذي تكتبه ……ففي كل البرامج
ضع تعليق في بدايته يصف إسم البرنامج ومصمم البرنامج وجملة صغيرة عن
البرنامج تشرح فيها ما هو هدفك من البرنامج مثلا إظهار نتائج الناجحين .
وعند كتابة البرنامج ضع تعليق بجانب كل دالة لتشرح ما هو عملها بالضبط.

كيف أضيف التعليقات ؟
تستطيع إتباع القاعدة التالية




كود:
/*هنا أكتب أي تعليق أريد إضافته للبرنامج*/
كما في الأمثلة التالية:




كود:
/*this program talk about the sum between two numbers*/
وأيضا تستطيع إضافة نص بأكمله يتكون من أكثر من سطر




كود:
/*Hello programmer……………..join with me to write a program about the factorial for any number enter from the user……..it is an easy program …………let's do it together*/
وأيضا أريد إخبارك بشيء…………فأنت تستطيع إضافة تعليق بهذه الطريقة التي تكتب بلغة السي بلس بلس




كود:
//hi………it's me
وتلك الطريقة أي اضافة // ومن ثم كتابة التعليق تنفع لإضافة سطر واحد فقط .

أين أَضع التعليقات؟
أنظر إلى هذا البرنامج البسيط ومن ثم تمعن في أي الأماكن وضعت التعليقات




كود:
/*this program will ask the user to enter two number and then print it*/

#inlcude
int main(int)
{
/*ask the user to enter two numbers*/

printf("Enter two numbers ,please");
scanf("%d%d",x,y);
/*the program will print the both of the numbers*/
printf("your's numbers are:%d %dn",x,y);
/*end of the program*/
return(0);
}
إذن تستطيع إضافة التعليقات في أي مكان ترغب به في البرنامج ولكن
هنالك نقطة مهمة يجب أن تنتبه لها………فأنت لا تستطيع إضافة تعليق في وسط
الأوامر مثلا




كود:
prin/*hi……..programmer*/tf
فمن الخطأ أن تضيف البرنامج في وسط الأوامر بل تستطيع إضافتها بعد أوقبل الجمل والأوامر الرئيسية.
ولقد كان ذلك هو درس التعليقات ، اتمنى أن تكون قد اقتنعت بأن التعليقات مهمة جدا…دعنا نغير جو السي الجاد ولأخبرك بقصة طريفة .

كان أستاذ للغة السي قد طلب من طلابه كتابة برامج معينة بلغة السي ، وطبعا
منهم المجتهد ومنهم الكسول………وكان هنالك صديقان يكتبان البرامج معا فهم
يقسمان العمل بينهما………وكل شخص منهم كتب برنامجان فأصبح مجموع البرامج هي
أربعة وعند تسليم البرامج للأستاذ……وضع لكل شخص منهم نصف الدرجة بالرغم من
أن البرامج مكتملة وتعمل بطريقة صحيحة ، فاستغربوا من ذلك وسألوا الاستاذ
لماذا نصف الدرجة، ولم يخطر في ذهن أي شخص منهم بأن الاستاذ قد كشف لعبتهم
هذه في المشاركة في كتابة الواجب…….فكيف اكتشف الاستاذ طريقتهم؟

بكل بساطة حينما كتب كل شخص منهم البرنامجين ، كتب كل شخص منهم في أعلى
البرنامج اسمه ، ظن منهما بأن كل واحد سوف ينتبه لذلك ويغير الاسم لاسمه ،
ولكن للأسف لم ينتبها لذلك ……………فكان سر اكتشاف الاستاذ لهم هو
التعليقات…………!!!