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