আমি সোর্স কোড এবং মন্তব্য সফ্টওয়্যার পণ্য ডকুমেন্টিং এর মন্তব্য। এটি আমার ব্যক্তিগত অভিজ্ঞতা এবং পর্যবেক্ষণ যে উত্স কোডটিতে কঠোরভাবে মন্তব্য করা হয়েছে সে বিষয়ে কাজ করা আমাকে বিভিন্ন উপায়ে সহায়তা করেছে যখন আমাকে সফ্টওয়্যার বিকাশ করতে হয়েছিল বা বজায় রাখতে হয়েছিল।
তবে আরও একটি শিবির রয়েছে যা বলেছে যে মন্তব্য করা শেষ পর্যন্ত অর্থহীন বা এর মান প্রশ্নবিদ্ধ। কোডিংয়ের অসংখ্য সমর্থক মন্তব্য না করেই যুক্তি দেয় যে:
- কোনও কোডের অংশটি যদি ভালভাবে লিখিত হয় তবে এটি স্ব ব্যাখ্যাযোগ্য এবং তাই মন্তব্য করার প্রয়োজন নেই does
- যদি কোনও কোডের টুকরো স্ব-বর্ণনামূলক না হয়, তবে এটিকে রিফ্যাক্টর করুন এবং এটিকে স্ব-বিবরণী করুন যাতে এটির কোনও মন্তব্যের প্রয়োজন না হয়
- আপনার পরীক্ষার স্যুটটি আপনার লাইভ ডকুমেন্টেশন
- সময়ের সাথে সাথে কোড এবং মন্তব্যগুলি সিঙ্কের বাইরে চলে যায় এবং এটি মাথা ব্যথার অন্য উত্স হয়ে যায়
- চটপটে বলেছেন ডকুমেন্টেশনের স্তূপের চেয়ে ওয়ার্কিং কোড বেশি গুরুত্বপূর্ণ, তাই আমরা মন্তব্যগুলি নিরাপদে উপেক্ষা করতে পারি
আমার কাছে এটা ঠিক মতবাদ। আবার, আমার ব্যক্তিগত পর্যবেক্ষণটি হ'ল স্মার্ট এবং অভিজ্ঞ বিকাশকারীদের দল দ্বারা লিখিত সফ্টওয়্যারটি শেষ পর্যন্ত একটি যথেষ্ট পরিমাণ কোড দিয়ে শেষ করে যা স্ব-ব্যাখ্যাযোগ্য নয়।
আবার, জাভা এপিআই, কোকো এপিআই, অ্যান্ড্রয়েড এপিআই ইত্যাদি দেখায় যে আপনি যদি মানের ডকুমেন্টেশন লিখতে এবং বজায় রাখতে চান তবে এটি সম্ভব।
এগুলি বলার পরেও দলিল সংক্রান্ত নথিপত্র সম্পর্কে ধারণা এবং ব্যক্তিগত বিশ্বাসের ভিত্তিতে উত্স কোডে মন্তব্য করা সাধারণত ভালভাবে শেষ হয় না এবং সন্তোষজনক সিদ্ধান্তে পৌঁছায় না।
এর মতো আমি সফটওয়্যার ডকুমেন্টেশনের প্রভাবগুলি, বিশেষত উত্স কোডের মন্তব্য, এর গুণমান এবং রক্ষণাবেক্ষণের পাশাপাশি টিমের উত্পাদনশীলতার উপর এর প্রভাবগুলি সম্পর্কে একাডেমিক গবেষণাগুলি এবং গবেষণামূলক গবেষণার সন্ধান করছি।
আপনি কি এই জাতীয় নিবন্ধগুলিতে হোঁচট খেয়েছেন এবং সেগুলির পরিণতি কী হয়েছে, যদি থাকে?