ما هو توثيق الدوال؟

كلمة توثيق قد لا تكون مألوفة لديك بالعربية، ولكن لابد أنك تعرفها بالإنجليزية وهي Documentation، وهي الوثائق التي يتم فيها تفصيل كل خصائص اللغة البرمجية، فمثلُا لغة PHP ستجد التوثيق الخاص بها في http://php.net/docs.php

دعنا نتحدث عن التوثيق في المحررات الذكية.

المحررات الذكية أو كما تعرف بـ IDE تقوم بعرض توثيق للدوال أثناء كتابتها ويكون التوثيق غالبًا من مصادرها الرسمية، وكل ما تقوم به هذه المحررات هي عرض هذا التوثيق أثناء كتابة الدالة، هذه الميزة ليست بديلة للمصادر الرسمية، ولكنها مفيدة وخاصة لمن يريد استذكار الدالة بشكل سريع أثناء الكتابة.

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

هل تريد معرفة طريقة استخدام هذه الميزة؟

شاهد هذا الفيديو من الدقيقة 26 و 35 ثانية وسترى الأستاذ محمد يحيى يقوم باستخدام هذه الميزة، وكيف أنها مفيدة.

https://youtu.be/pz514YaGE3M?t=26m35s

لا أدري إن كانت هذه الميزة مدعومة في المحررات العادية، ولكنها ميزة عظيمة بنظري، لأنك لو قمت بكتابة مئات الدوال بنفسك وجاء يوم استخدمت فيه أحد هذه الدوال وقد نسيتها، فعند كتابتها فقط ستظهر كل التفاصيل التي كتبتها أنت في وقت سابق.