هل يجب إجراء اختبارات JUnit بواسطة javadocced؟

Question

لدي عدد من حالات اختبار JUnit التي لم يتم توثيقها حاليًا بتعليقات Javadoc.

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

Answer 1

إذا كان الغرض من الاختبار واضحا فلا أهتم بتوثيقه.

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

Answer 2

وأنا لا أجد أي قيمة في javadocing حالات الاختبار. أنا فقط جعل اسم المنهج الوصفي يكفي أن نعرف الغرض من الاختبار.

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

Answer 3

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

Answer 4

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

استخدم طويلة، أسماء وصفية للاختبارات، والحفاظ على رمز اختبار قراءة قدر الإمكان.

وعلى سبيل المثال إلقاء نظرة على حالات الاختبار <لأ href = "http://github.com/orfjackal/tdd-tetris-tutorial/tree/beyond/src/test/java/tetris/" يختلط = "نوفولو noreferrer "> في هذا المشروع . هل هناك أي منهم القيام بشيء التي ليست واضحة بشكل صارخ من خلال النظر في اسم الاختبارات ورمز الاختبار؟

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

Answer 5

وأنا لا أرى لماذا يجب علاج حالات الاختبار أي بشكل مختلف عن رمز الإنتاج الخاص فيما يتعلق التعليقات.

Answer 6

واعتقد انها قيمة لجافادوك الظروف التي تمر الاختبارات.

Answer 7

هل بدعة تشير إلى أن تعليقات التعليمات البرمجية هي نموذج مضاد؟ وأنا أتفق مع الإجابات أعلاه، من الناحية المثالية التعليمات البرمجية سيكون صفي يكفي الاعتماد على دون تعليق. هذا ينطبق بشكل خاص إذا كنت في (المؤسسة) بيئة حيث يميل الناس لتحديث الرمز دون تحديث تعليقات من التعليقات تصبح مضللة.

Answer 8

ونعم الجحيم. حتى لو كان مجرد ...

وإنشاء النظام، وتحرير النظام، حفظ، وتحميل والتحقق من ذلك.

وإذا به في اختبار بسيط حقا، ثم ربما لا.

وأجد أنه رمز التغييرات، في بعض الأحيان سببا لاختبار ليس واضحا كما كان من قبل.

Answer 9

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

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

يتم التعامل مع

والاختبارات مثل الرمز وقدمت كجزء من عملية مراجعة النظراء لذلك لدينا (صغير) فريق يمكن التعليق حول ما إذا كان الاختبار بسهولة فهمها أم لا.

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