الغرض من الكتابة
تحدد هذه المواصفات ملفات البرنامج وأسلوب الترميز المتضمن في عملية كتابة البرنامج. تم تطوير هذه المواصفات بناءً على لغة دلفي.
تنظيم وثائق المشروع
في دلفي، يتم تنظيم ملفات البرنامج وفقا لوحدات المشروع. في مشروع نموذجي تشمل:
ملفات المشروع (ملفات .DRP)
يحتوي على كود باسكال المصدري للبرنامج الرئيسي للمشروع؛
ملفات الوحدة (ملفات .PAS)
ملف باسكال المصدري لكل نموذج في المشروع، بما في ذلك جميع الإعلانات وإجراءات النموذج (بما في ذلك إجراءات معالجة الوقت)؛
ملفات النماذج (ملفات .DFM)
ملف ثنائي يحتوي على خصائص تصميم النموذج. يتوافق ملف .DFM وملف .PAS لكل نموذج مع بعضهما البعض.
ملف المورد (ملف .RES)
ملفات الموارد الثنائية المترجمة والمرتبطة بالملف القابل للتنفيذ الخاص بالتطبيق؛
ملف خيارات المشروع (ملف .DOF)
يخزن خيارات المشروع التي تم تعيينها بواسطة أمر القائمة PProject|Options؛
ملف إعدادات سطح المكتب (ملف .DSK)
يخزن خيارات سطح المكتب التي تم تعيينها بواسطة أمر القائمة Tools|Options؛
ملف الحزمة (ملف .DPK/.BPL)
الملفات المستخدمة لمشاركة المكونات والفئات والبيانات والتعليمات البرمجية. الملف المصدر هو ملف .DPK وبعد التحويل البرمجي يكون ملف .BPL؛
تعريف ثابت
محتوى:
تعريف القيم المنطقية.
تعريف القيمة الثابتة؛
تعريف رمز الخطأ؛
التنسيق: تعريف واحد لكل سطر. على النحو التالي:
Const<constant>: type = value;
يوضح:
استخدم عبارة Const لتعريف الثوابت المستخدمة بدلاً من القيم الحرفية.
مثال: Const C_SQL:string='select CH_USERER_ID من T_CD_USER';
Const C_PI:real =3.1415926;
تعريف نوع الهيكل
المحتوى: تعريف نوع الهيكل
شكل:
يكتب
<اكتب الاسم>// تعليقات وصف الهيكل
<اسم المتغير 1>: نوع المتغير؛ // تعليقات الوصف المتغير
<اسم المتغير 2>: نوع المتغير؛ // تعليقات الوصف المتغير
…
نهاية؛
يوضح:
<اسم النوع> عبارة عن سلسلة تبدأ بحرف كبير. تبدأ العبارات التي تحدد أنواع المتغيرات في تعريف البنية في الصف الثاني والعمود الخامس.
مثال:
يكتب
TableList=record //تعريف نوع وحدة شجرة النظام
InID: عدد صحيح؛ // رقم الوحدة
الاسم: سلسلة // اسم الوحدة
PID: سلسلة؛ // اسم الوحدة السابقة
PT: PTableList; // مؤشر لنوع الوحدة التالي
نهاية؛
أسلوب البرمجة
يحدد أسلوب البرمجة قواعد تحديد المواقع لكل عبارة والتعليقات في البرنامج.
أسلوب الوظيفة / الإجراء
<الوظيفة/الإجراء> الاسم (المتغير: نوع المتغير [،...])؛//وصف الوظيفة/الإجراء
فار
المتغير 1: نوع المتغير؛ // وصف المتغير
المتغير 2: نوع المتغير؛
…
يبدأ
إفادة؛
إفادة؛
…
نهاية ؛
ملاحظة: تتم كتابة الإعلانات والبيانات المتغيرة بدءًا من العمود الثالث، إذا كان هناك مسافة بادئة، فقم بوضع مسافة بادئة لها بعمودين في كل مرة وقم بمحاذاتها مع البيانات المقابلة.
أسلوب البيان
يوضح:
يوجد عادةً وصف وظيفة فقرة واحدة لكل عشرة أسطر على الأكثر في نص البرنامج؛
توحيد استخدام البيانات المختلفة؛
المسافة البادئة في البيانات تكون في وحدات من عمودين.
بيان تعريف المتغير
فار
var_name: <نوع البيانات>؛
بيان المهمة
var_name: = <expression>;
بيان مشروط
إذا كان الشرط ثم // تعليق
يبدأ
إفادة؛
…
نهاية
وإلا إذا كان الشرط ثم // تعليق
يبدأ
إفادة؛
...
نهاية
آخر // تعليق
إفادة؛
ملاحظة: إذا كان هناك بيان تنفيذ واحد فقط، فيمكن حذف بياني البداية والنهاية.
بيان حلقة
// شرح وظيفة الحلقة
للعداد := البداية إلى النهاية do
يبدأ
[إفادة]؛
…
نهاية؛
// شرح وظيفة الحلقة
بينما [الحالة] تفعل
يبدأ
[إفادة]؛
…
نهاية؛
// شرح وظيفة الحلقة
يكرر
[إفادة]؛
…
حتى [الشرط]
بيان التبديل
// وصف وظيفة التبديل
حالة <التعبير> من
<القيمة1>:[البيان 1];
<القيمة2>:[البيان 2];
…
<القيمة>: [بيان ن]
نهاية؛
خط التعليق
يجب أن تكون هناك تعليقات "وصف الوحدة" و"وصف الوحدة" لملف الوحدة هذا أعلى ملف وحدة رمز البرنامج.
بالنسبة لأجزاء التعليمات البرمجية ذات المعنى مثل الثوابت، والأنواع الهيكلية، والوظائف/الإجراءات، والمتغيرات المخصصة، وكتل وظائف مقطع التعليمات البرمجية، والبيانات الرئيسية، وما إلى ذلك.
النقاط، يجب أن يكون هناك سطر تعليق لشرحها بالتفصيل.
يمكن إضافة سطر التعليق بـ "//XXXXXXXXX" بعد السطر الذي يحتاج إلى شرح، أو يمكن أيضًا إضافته فوق السطر الذي يحتاج إلى شرح.
أضف عدة أسطر باستخدام "{XXXXXXXXX}" أو أضف سطرًا واحدًا باستخدام "//XXXXXXXX".
تسمية الملفات والنماذج
معنى تنسيق تسمية اسم الفئة
برنامج ملف المشروع (.DPR) XXXX
الوحدة (PAS) uXXXXXX
FormForm.Name(.DFM) XXXXXXFrm
وحدة البيانات DataModule XXXXXXDM
تعريف رأس الوحدة، يضاف أمام كل وحدة.
{*************************************************************************************************************************************************************************** * ***
اسم الوحدة:
وصف الوظيفة:
مؤلف:
اسم البرنامج:
إصدار:
اسم الشركة: Sword as Dream Software Creation Studio
*************************************************************************************************************************************************************************** * *** }
تعريف تنسيق رقم إصدار البرنامج:
يستخدم البرنامج تنسيق رقم الإصدار التالي: XXXX
على سبيل المثال: بعد اكتمال البرنامج القابل للإصدار، يتم وضع علامة على رقم الإصدار بأنه "1.0.0.0"
الرقم الأول: رقم الإصدار. ملحوظة: هذه نسخة من البرنامج تم تحسينها بشكل كبير.
الرقم الثاني: رقم الصيانة. ملحوظة: تم تعديل بعض الأخطاء بناءً على الإصدار الموجود.
الرقم الثالث: رقم التصحيح. ملاحظة: عندما يقوم البرنامج بتصحيح بعض الأخطاء وعدم تكوين رقم صيانة جديد، يتم استخدام رقم التصحيح.
الرقم الرابع: رقم التصحيح. ملاحظة: عند حدوث خطأ في برنامج الطوارئ، يتم استخدام البرنامج المعدل كمعرف، وليس كرقم إصدار البرنامج الذي تم إصداره. yckxzjj