التجريد والتوثيق في بناء الانظمة
احدى مبادئ البرمجة الكائنية التوجه هي التجريد Abstraction
وببساطة هذا المفهوم يعني استخدام الكلاسات او البرمجيات المكتوبة من قبل اشخاص اخرين واستخدامها في الكود المصدري الخاص بك بشكل مبسط جدا ومجرد من التعقيدات الداخلية. كل ما عليك معرفته هو الوظيفة ، القسم الداخلة والخارجة من هذا الجزء البرمجي (كلاس او دالة برمجية)
لذلك حين يتم كتابة الكود البرمجي يجب اني نراعي هذا المفهوم، عن طريق كتابة تعليقات وتوثيق داخل الكود نفسه او بناء صفحات ويب عامة تشرح طرق التعامل مع الكود المصدري الخاص بنا.
لغة بايثون تسمح لك بعمل التوثيق بشكل مباشر داخل الكود المصدري وبشكل يسهل قراءته باستخدام دالة الـ help التي وظيفتها بكل اختصار تجلب التعليمات الخاصة باستخدام كلاس او ميثود او فانكشن.
هناك علاقة رائعة بين دالة help والـ DocString في البايثون
ماتقوم كتابته في الDocstring سيتعبر هو الشرح الذي سيظهر عن استدعاء الدالة help
تعليقات
إرسال تعليق