من إجراءات التوثيق، كتابة تعليقات وصفية للمقاطع البرمجية؟؟
الإجابة الصحيحة من خلال موقع بوابة الإجابات هي:
صواب
الإجابة الصحيحة هي صواب.
لماذا تُعتبر كتابة التعليقات الوصفية للمقاطع البرمجية من إجراءات التوثيق؟
التوثيق في البرمجة هو عملية كتابة شروحات ومعلومات حول البرنامج أو الكود لكي يفهمه أي شخص يقرؤه (سواء كان أنت بعد فترة زمنية، أو شخصاً آخر يعمل معك). وتُعد التعليقات (Comments) إحدى أهم وأسهل طرق التوثيق للأسباب التالية:
- توضيح الغرض من الكود: التعليقات هي عبارة عن نصوص يكتبها المبرمج داخل الكود لغةً بشرية (مثل العربية أو الإنجليزية)، ولا يقوم الحاسوب بتنفيذها. وظيفتها الأساسية هي شرح ما يفعله هذا الجزء من البرنامج.
- تسهيل التعديل والصيانة: عندما تعود لقراءة برنامجك بعد عدة أشهر، قد تنسى لماذا كتبت هذا السطر. التعليقات الوصفية تذكرك سريعاً بالهدف منه، مما يجعل تعديله أو إصلاح الأخطاء فيه أمراً سهلاً.
- العمل الجماعي: في المشاريع الكبيرة، يشارك أكثر من مبرمج في كتابة الكود. تساعد التعليقات الوصفية أعضاء الفريق على فهم دور كل مقطع برمجي كتبه شخص آخر دون الحاجة لقراءة كل كود السطور بالتفصيل.
مثال توضيحي:
لو كتبنا هذا السطر البرمجي لحساب مساحة المستطيل:
`area = length * width`
إذا وضعنا قبله تعليقاً وصفياً هكذا:
`// هذا المقطع لحساب مساحة المستطيل بضرب الطول في العرض`
فهذا التعليق يعتبر جزءاً من توثيق البرنامج، لأنه يوضح للناظر وظيفة السطر البرمجي مباشرة وبكل بساطة.
اذا كان لديك إجابة افضل او هناك خطأ في الإجابة علي سؤال من إجراءات التوثيق، كتابة تعليقات وصفية للمقاطع البرمجية؟ اترك تعليق فورآ.
