ইউনিট পরীক্ষার মামলার জন্য জাভা ডক মন্তব্য লিখছেন

Question

আমার মতে, ইউনিট পরীক্ষার কেসগুলি কোডের জন্য একটি ডকুমেন্টেশন হিসাবে কাজ করে। আমার সংস্থাটি চায় ইউনিট পরীক্ষার মামলার শীর্ষে আমি জাভা ডকের মন্তব্য লিখতে চাই। এটি করা কি দরকার? আপনি কি মতামত লিখেন?

Comments

পরীক্ষার কোডটি অনুমানযোগ্যভাবে লিখিত এবং পাঠযোগ্য, পরীক্ষার কোডে এই ধরণের একটি মন্তব্যের প্রাথমিক মান হ'ল অভিপ্রায় হিসাবে একটি বিবরণী .. যা কোড পর্যালোচকদের পক্ষে এমনকি মূল্যবান হতে পারে, এমনকি নিজেকে এক বছরের মধ্যেও, যেমন এটি আপনাকে অনুমতি দেয় কোডটি যা লিখেছিল তা বিচার করার জন্য এটি যা করার কথা তা করছে বা এটি যা পরীক্ষা করার কথা বলেছিল তা পরীক্ষা করে। দ্বিতীয়ত আপনি জাভাডোকের মতো সিস্টেমগুলি ব্যবহার করতে পারেন এমনকি কোডের মাধ্যমে পরীক্ষার নাম এবং মন্তব্যগুলি স্ক্র্যাপ করতে আপনার কী পরীক্ষা রয়েছে এবং কী করছে সেগুলি সম্পর্কে ডকুমেন্টেশনের একটি দ্রুত বিট তৈরি করতে পারেন।

— চক ভ্যান ডের লিন্ডেন 21

Answer 1

আমি যা করি জাভাদোক-মন্তব্য:

• ক্লাসটি, কোন ক্লাসটি ইউনিট পরীক্ষিত তা নির্দেশ করে (যদিও বিষয়টি আমার পক্ষে সুস্পষ্ট হওয়া উচিত যদিও সেই বিষয়ে সেরা অনুশীলন থেকেই বোঝা যায় যে পরীক্ষার কেসটির নামটি ক্লাসের নাম হতে হবে "" টেস্ট "বা" টেস্টকেস ")। এটি l @ লিঙ্ক XXX ক্লাস} জাভাদোক মন্তব্য ব্যবহার করে করা হয়েছে

• পদ্ধতিগুলি, কোন পদ্ধতিটি পরীক্ষা করা হচ্ছে তা নির্দেশ করে (l @ লিঙ্ক XXX ক্লাস # পদ্ধতি 1 l)। কোনও কোনও শ্রেণীর একটি পদ্ধতির জন্য সমস্ত পাথ সঠিকভাবে পরীক্ষা করতে আমার মাঝে মাঝে একাধিক পরীক্ষার পদ্ধতি নেওয়া দরকার। এটি যখন ঘটে তখন আমি ভিতরে একটি অতিরিক্ত পংক্তি লিখি যাতে আমি কী পথে ভিতরে পরীক্ষা করছি (তবে আমি কখনই আমার এক-লাইন সম্মেলন থেকে দূরে সরে যাই না)

তা ছাড়া অন্য কোনও মন্তব্য নেই। অন্য কোথাও তাদের দৃষ্টি আকর্ষণ করার জন্য আপনি চমত্কার কোড কভারেজ গ্রাফিক্স তৈরি করতে এবং সেভাবে তাদের খুশি করতে কোবার্টুরার মতো কিছু ব্যবহার করতে পারেন :-)

অতিরিক্ত নোট: আমি ইউনিট পরীক্ষার কেসগুলিকে উল্লেখ করছি, আমরা যদি ইন্টিগ্রেশন টেস্টের মামলার কথা বলি, তবে কী চলছে তা বোঝাতে আরও একটি বা দুটি লাইন সম্ভবত প্রয়োজনীয় হতে পারে ...

Answer 2

যে কোনও কোডের জন্য ডকুমেন্টেশন প্রয়োজনীয়তা এই প্রশ্নের উত্তরে মোটামুটি সম্পূর্ণভাবে কভার করা হয়েছে: আমার বস আমাদের কোডটির বর্ণিত লাইন বাই লাইন ইংরেজি ব্যাখ্যা চান

উত্তরগুলির সংক্ষিপ্তসার হিসাবে আপনি সেখানে দেখতে পাবেন, "এটি আপনার পরিস্থিতির উপর নির্ভর করে"। এমন কিছু ঘটনা রয়েছে যেখানে এটি যুক্তিসঙ্গত (এবং উত্সাহিত) হয় এবং অন্যান্য যেখানে এটি আপনার সময় নষ্ট করে।

Answer 3

জাভাডোক মন্তব্যগুলি আলাদা রেফারেন্স ডকুমেন্টে উত্তোলন এবং ফর্ম্যাট করা যায়, ইউনিট পরীক্ষাগুলি পারে না। এছাড়াও, মনে রাখবেন যে আপনি কথায় যা লিখছেন তা আসল কোড থেকে আলাদা হতে পারে এবং সাধারণত আপনি কথায় প্রকৃত প্রত্যাশিত আচরণ বর্ণনা করে যাচ্ছেন। বাগগুলি সন্ধান করার একটি উপায় হ'ল ডকুমেন্টেশনগুলিকে আসল কোডের সাথে তুলনা করা, যদি এটি মেলে না - এটি একটি বাগ (এর মধ্যে দুটিতে এবং কখনও কখনও - উভয়ই)।

ইউনিট পরীক্ষা টেস্টিংয়ের জন্য, ডকুমেন্টেশনের জন্য নয়। ডকুমেন্টেশন হিসাবে ইউনিট পরীক্ষা ব্যবহার করা ভুল এবং করা উচিত নয়।

Comments

কোডটি ডকুমেন্টিংয়ের ক্ষেত্রে আমি ইউনিট পরীক্ষার একটি ভাল স্যুটটি অত্যন্ত সহায়ক। সেভাবে ব্যবহার করার সময় কোডটি সঠিকভাবে আচরণ করে এমন প্রমাণের সাথে তারা কারও কোডটি কীভাবে ব্যবহার করা উচিত সে সম্পর্কে একটি রেফারেন্স বাস্তবায়ন সরবরাহ করে ।

— বিল মিশেল

@ বিল - এটির পক্ষে কোনও যুক্তি নয়, এটি সহায়ক। এটি সঠিক ডকুমেন্টেশন প্রতিস্থাপন করে না ।

— littleadv

আপনার ডকুমেন্টেশনের জন্য দর্শকদের উপর নির্ভর করে - তবে কিছু ক্ষেত্রে আপনি অবশ্যই সঠিক।

— বিল মিশেল

আদর্শভাবে ইউনিট পরীক্ষাগুলি কোনও সিস্টেমের একমাত্র ডকুমেন্টেশন হওয়া উচিত নয় - তবে বাস্তব বিশ্বে 10 টির মধ্যে 9 টি প্রকল্প লিগ্যাসি কোড নিয়ে কাজ করছে যেখানে কোনও ডকুমেন্টেশন থাকা ভাগ্যবান বলে বিবেচিত হতে পারে । এবং এই ক্ষেত্রে, আমি দস্তাবেজের একটি গোছায় যা ইউনিট পরীক্ষাগুলি পুরোপুরি প্রকৃত কোডের সাথে সিঙ্কের বাইরে চলে যেতে পারে তার উপর চলমান এবং পাসের ইউনিট পরীক্ষার একটি ভাল সেট পছন্দ করি। (হ্যাঁ, এমনকি জাভাদোকও পারেন))

— তারেক

@ পেটারটোরাক হ্যাঁ ... আমি বেশ কয়েকটি বিভিন্ন নিয়োগকারী, কিছু খুব পরিচিত কোম্পানির মধ্যে চলে এসেছি। প্রচুর লিগ্যাসি কোড। একমাত্র ইউনিট পরীক্ষা করে - যা আমি লিখেছি। সুতরাং আপনি খুব ভাগ্যবান ছিল। আপনি যা দেখেছেন তা সর্বত্র যা ঘটেছিল তা মনে করবেন না। এমনকি আপনার ইউনিট পরীক্ষার সেট থাকলেও ... কে বলেছিল যে তারা সঠিক? কে বলেছে যে তাদের কী করা উচিত? কে বলেছে যে প্রত্যাশিত ফলাফল তারা কী? আপনি কেন ধরে নিলেন যে ইউনিট পরীক্ষাগুলি সিঙ্কের বাইরে নেই? কেবল তারা "পাস" করার কারণে? ছাইপাঁশ.

— littleadv