ما هي وظائف المثال في الذهاب؟

الماخذ الرئيسية

• وظائف الأمثلة في Go عبارة عن مقتطفات تعليمات برمجية قابلة للاختبار تعمل بمثابة وثائق ويمكن استخدامها للتحقق من صحتها.
• تتبع وظائف المثال اصطلاح التسمية ويمكن تعريفها للحزم والوظائف والأنواع والأساليب.
• تعتبر وظائف الأمثلة بمثابة اختبارات قابلة للتنفيذ ويمكن استخدامها لضمان الاعتماد على التعليمات البرمجية والحفاظ على تحديث الوثائق.

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

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

ما هي وظائف المثال؟

الوظائف النموذجية (أو الأمثلة) في Golang هي مقتطفات من التعليمات البرمجية قابلة للاختبار يمكنك إضافتها إلى الحزمة كوثائق والتحقق من صحتها. لا تأخذ وظائف المثال معلمات ولا تُرجع نتيجة أيضًا.

تخيل أن لديك ما يلي تتضاعف الوظيفة في مشروعك:

funcMultiply(a, b int)int {
return a * b
}

وظيفة مثال ل تتضاعف سوف تبدو مثل هذا:

funcExampleMultiply() {
 fmt.Println(Multiply(4, 5))
// Output: 2
}

تستخدم وظائف المثال اصطلاح تسمية مشابهًا لاختبار الوظائف. قم بتعريف مثال دالة عن طريق إضافة اسم الدالة كلاحقة لكلمة "مثال"، كما هو الحال مع مثال ضرب هنا.

إلقاء نظرة فاحصة على وظائف المثال

يُظهر الكود الموجود في القسم السابق البنية الأساسية لوظيفة المثال. ما يشكل مثالاً هو الاسم ونص الوظيفة وتعليق الإخراج الاختياري في نهاية الوظيفة.

عند إضافة تعليق الإخراج، يقوم Go بتجميع المثال وتنفيذه للتحقق من صحته، ولكن بدون التعليق، يقوم Go فقط بتجميع وظيفة المثال، ولا ينفذها.

يمكنك تحديد مثال لحزمة ووظيفة ونوع وطريقة على نوع ما.

يتطلب تحديد الأمثلة للكيانات المختلفة أساليب مختلفة.

1. لتحديد مثال لحزمة، ما عليك سوى استدعاء الدالة الخاصة بك مثال()، دون أي لاحقة. على سبيل المثال، إليك مثال على مستوى الحزمة:

   funcExample() {
    fmt.Println("Hello, world!")
   // Output:
   // Hello, world!
   }

2. لتعريف مثال لوظيفة ما، ما عليك سوى إضافة اسم الوظيفة كلاحقة كما تعلمت سابقًا.

   funcExampleMultiply() {
    fmt.Println(Multiply(4,5))
   // Output: 2
   }
   

3. لتعريف مثال لنوع ما، أضف الاسم كلاحقة إليه مثال. هنا مثال:

   type MyStruct struct {
   // ...
   }
   funcExampleMyStruct() {
   // ...
   }
   

4. وأخيرًا، بالنسبة لطريقة ما على نوع معين، يمكنك إضافة اسم النوع، وشرطة سفلية، ثم اسم الطريقة. وهنا مظاهرة:

   func(m *MyStruct)MyMethod() {
   // ...
   }
   funcExampleMyStruct_MyMethod() {
   // ...
   }
   

يمكنك تحديد أمثلة متعددة لكيان ما عن طريق إضافة شرطة سفلية إضافية ولاحقة تبدأ بحرف صغير. على سبيل المثال، مثالMultiply_sec, exampleMyStruct_MyMethod_ Second.

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

مثال الملف بأكمله هو ملف ينتهي بـ _test.go ويحتوي على وظيفة نموذجية واحدة بالضبط، ولا توجد وظائف اختبار أو قياس أداء، وإعلان واحد آخر على مستوى الحزمة على الأقل. عند عرض مثل هذه الأمثلة، سيعرض godoc الملف بأكمله. - مدونة Go Dev

يتعرف محرك Go على وظائف المثال الخاصة بك ويتعامل معها وفقًا لكيفية تعريفها.

يمكنك استخدام ال إخراج غير منظم بديل لتعليقات الإخراج. يعد هذا مفيدًا بشكل خاص في السيناريوهات التي تقوم فيها وظيفتك بإرجاع قائمة غير متوقعة بترتيب معين.

توثيق التعليمات البرمجية الخاصة بك مع وظائف المثال

تعد وظائف الأمثلة مفيدة لكل من أغراض التوثيق والاختبار. عادة ما تقوم وظيفة المثال بعمل أفضل في شرح السلوك من التعليقات.

تماما مثل جافا جافادوك، اذهب أداة التوثيق المضمنة، godoc، يساعد على توثيق التعليمات البرمجية بسهولة. ولكنك ستحتاج إلى توثيق بعض المكتبات والوظائف معًا لتوفير فهم أكثر اكتمالاً لكيفية عملها. تقضي الأمثلة على هذه النكسة لأنها يمكن أن توضح التفاعلات بين الوحدات المختلفة للحزمة.

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

يمكنك تجربة حزمة أو طريقة مباشرة من الوثائق قبل استخدامها في التعليمات البرمجية الخاصة بك.

تظهر هذه الصورة مثالا على json. صالح وظيفة تحت الترميز/json:

استخدام وظائف المثال لاختبار الوحدة

تعتبر وظائف المثال Go أيضًا اختبارات قابلة للتنفيذ. عند تشغيل اذهب للاختبار الأمر، يقوم المحرك بتشغيل كل دالة نموذجية مع تعليق الإخراج النهائي ويضمن تطابق مخرجاته مع ما هو موجود في التعليق.

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

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

يساعد هذا كثيرًا في منع التوثيق القديم، حيث أن التوثيق الخاص بك سيكون دائمًا محدثًا بالكود.

تُنتج الوظائف النموذجية تعليمات برمجية ووثائق موثوقة

يعد التوثيق جزءًا أساسيًا من تطوير البرامج، لكن القليل من اللغات يمنحك منصة قوية لتوثيق التعليمات البرمجية الخاصة بك واختبارها.

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