التوثيق الخاص بالكود

مرحباً @عبد الواحد الحدادي

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

مثلاً: 

• توثيق لغة php
• توثيق إطار laravel
• توثيق إطار flutter
• توثيق vue js
• و غيرها الكثير 

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

التوثيق هو أي شيء تكتبه بالإضافة إلى الكود الخاص بك لمساعدة شخص آخر على فهم كيفية عمله. و  أحد الأمثلة الجيدة لتوثيق الكود هو ملف README و Express.js  يجيب على العديد من الأسئلة المهمة حول إطار العمل ويخبرك كيف يمكنك تضمينه في مشروعك ، وكيفية تثبيته ، وكيفية إجراء الاختبارات.

من المهم توثيق الكود بالذات للمشاريع الكبيرة ; لأنه لا يجب على الأشخاص قراءة الكود  بالكامل لفهم ما تفعله , حتى ولو قمت بإستخدام التعليقات التي تشرح ألية عمل الكود فهذه تعتبر من التوثيق .

سيوفر عليك الوقت في المستقبل لفهم كودك البرمجي وأيضاً سيوفر الوقت على فريق العمل الذي يقوم بتطوير كود المشروع الخاص بك .

بالتوفيق لك..