الفرق بين المراجعتين لصفحة: «دليل الرسائل القصيرة السريعة للمطورين/توثيق البرنامج بستخدام inline و docstring»

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

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

كان هذا مثل على كيفية توثيق الموديول ؛ الطريقة المثلى للتوثيق ليس فقط توثيق الموديول و لكنولكن كتابة تعريف بسيط لتطبيق الذي قمت بإنشائه.

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