আমি এই বিষয়টি নিয়ে কিছুক্ষণ ভাবছিলাম।
আমার উপসংহারটি হ'ল - এটি পরিমাণের বিষয় নয়, তবে গুণমান এবং প্রসঙ্গে।
উদাহরণস্বরূপ, একটি যথাযথ প্রকল্প কাঠামো ফাইলগুলি কোথায় রয়েছে তা ব্যাখ্যা করে মন্তব্যগুলিকে মারধর করে (বাস্তবায়ন বনাম ইনটেনশন)
একইভাবে, প্রসঙ্গ বেট নামকরণের স্পষ্টকরণের শ্রেণিবদ্ধকরণ (একটি রোগীর আইডি -> রোগী.আইডি)।
আমি বিশ্বাস করি যে ভাল ডকুমেন্টেশনে ডিডিডির একটি বক্তব্য আছে - শ্রেণিবদ্ধকরণ প্রসঙ্গ সরবরাহ করে, প্রসঙ্গটি সীমানা তৈরি করে এবং সীমানা ইচ্ছাকৃত বাস্তবায়নের দিকে পরিচালিত করে (এটি যেখানে এটি বিদ্যমান, তার পরিবর্তে এটি প্রয়োজন)।
কোড নিজেই ডকুমেন্টেশন বিবেচনা করার পক্ষে যথেষ্ট ভাল নয়। বেশিরভাগ ক্ষেত্রে সমস্যাটি কোডটির কার্যকরী মন্তব্য করা বা মন্তব্য করা হয় না, বরং ড্রাইভিং ফোর্স (ডোমেন লজিক) নয় isn't
আমরা মাঝেমধ্যে কারা বস তা ভুলে যাই - যদি কোড পরিবর্তন হয় তবে ডোমেন যুক্তি বা যুক্তি হওয়া উচিত নয়, তবে যদি ডোমেন যুক্তি বা যুক্তি কোডটি পরিবর্তন করে তবে অবশ্যই তা হয়ে যাবে।
ধারাবাহিকতাও খুব গুরুত্বপূর্ণ - যদি এটি ধারাবাহিক না হয় তবে নিজেই কনভেনশন অকেজো।
ডিজাইনের ধরণগুলি কেবল 'ভাল অনুশীলন "নয় - এটি আমাদের বিকাশকারীদের বোঝানো উচিত। কোনও বিকাশকারীকে কারখানায় একটি নতুন ধরণের যুক্ত করতে বলা কোনও পদ্ধতিতে নতুন ধরণের যোগ করার চেয়ে বোঝা যায় (যেখানে প্রসঙ্গ এবং ধারাবাহিকতা দুর্বল বা অনুপস্থিত)।
অর্ধ সংগ্রাম চেনা ।
পার্শ্ব নোটে, API গুলি যেগুলি অনেকগুলি ডকুমেন্টেশনের পক্ষপাতী বলে মনে হয় সেগুলিও খুব ডোমেন এবং প্রসঙ্গে সংবেদনশীল। কখনও কখনও সদৃশ কার্যকারিতা খারাপ (একই জিনিস, বিভিন্ন প্রসঙ্গ) নয় এবং পৃথক হিসাবে বিবেচনা করা উচিত।
মন্তব্য করার ক্ষেত্রে, যুক্তির পিছনে ডোমেন যুক্তি প্রদর্শন করা সর্বদা ভাল।
উদাহরণস্বরূপ, আপনি চিকিত্সা শিল্পে কাজ করছেন। আপনার পদ্ধতিতে আপনি "ইসপ্যাটেন্টসেকচার = সত্য" লিখেছেন;
এখন, কোনও শালীন প্রোগ্রামারই বুঝতে পারেন যে রোগীটিকে সুরক্ষিত হিসাবে চিহ্নিত করা হচ্ছে। কিন্তু কেন? এর অর্থ কী?
এক্ষেত্রে রোগী এমন একজন বন্দী যেটিকে নিরাপদে কোনও অফ-প্রসেস হাসপাতালে স্থানান্তর করা হয়েছিল। এটি জানার পরে, ঘটনাসমূহ কল্পনা করা সহজ যেগুলি এই মুহুর্তে পৌঁছায় (এবং সম্ভবত এখনও কী ঘটবে)।
সম্ভবত এই পোস্টটি দার্শনিক মনে হচ্ছে - তবে মনে রাখবেন যে এটি 'যুক্তি' বা 'যুক্তি' যা আপনি লিখেছেন - কোড নয় -