ভালো কোড লেখার সাধারণ টিপস
ভালো কোড লেখার একটি অপরিহার্য অংশ হলো ভালো ফাংশনের নাম বেছে নেওয়া। আপনার ফাংশনের নাম দেওয়ার সময় নিচের পরামর্শগুলো বিবেচনা করুন।
আপনার ফাংশনের নাম দেওয়ার সময় এটি কী কাজ করে তা স্পষ্ট হওয়া উচিত।
উদাহরণস্বরূপ, get(studentId, subject) ফাংশনটির নাম অর্থবহ নয়, তাই এটি কী কাজ করে তা স্পষ্ট নয়।
এটি হয়তো শিক্ষার্থীর কোনো বিষয়ের গ্রেড আনছে, অথবা তার ভর্তির অবস্থা আনছে।
আরও ভালো নাম হবে getStudentGrade(studentId, subject), কারণ এটি ফাংশনটি ঠিক কী করে তা স্পষ্টভাবে জানায়।
ফাংশনের নাম যেন খুব লম্বা না হয় সেদিকে খেয়াল রাখুন।
উদাহরণস্বরূপ, checkStudentFailOrPassOrMeritOrDistinction(mark) একটি অপ্রয়োজনীয়ভাবে লম্বা ফাংশনের নাম।
নাম যত লম্বা হয়, মনে রাখা তত কঠিন হয় এবং কম্পিউটারের স্ক্রিনে তত বেশি জায়গা নেয়।
বিপরীতভাবে, ফাংশনের নাম খুব ছোট করলেও পাঠকদের বিভ্রান্ত করতে পারে।
উদাহরণস্বরূপ, checkFPMD(mark) একটি খারাপ ফাংশনের নাম, কারণ 'FPMD' মানে কী তা সঙ্গে সঙ্গে বোঝা যায় না।
আপনার ফাংশনের নাম এমন হওয়া উচিত যা আপনার কোড পড়ে এমন সবাই বুঝতে পারে।
উদাহরণস্বরূপ, DeathStar()-এর মতো একটি অস্পষ্ট ফাংশনের নাম আপনার কাছে মজার লাগতে পারে, কিন্তু নামটি এর উদ্দেশ্য জানায় না এবং আপনার কোড পড়া অন্য ডেভেলপারদের জন্য বিভ্রান্তির সৃষ্টি করতে পারে।
একই কাজ করে এমন অপারেশনের নামকরণে একটি রীতিতে অটল থাকুন।
উদাহরণস্বরূপ, যদি শিক্ষার্থীর নাম আনার ফাংশনের নাম আপনি getStudentName() দেন, তবে শিক্ষার্থীর গ্রেড আনার ফাংশনের নামে ভিন্ন ক্রিয়া ব্যবহার করা উচিত নয় (যেমন retrieveStudentGrade())।
উদাহরণস্বরূপ, একটি কালেকশনে কিছু আইটেম ঢোকানোর জন্য add ব্যবহার করে যাবেন না, যদি আপনি দুটি সংখ্যার যোগ করার জন্য আগেই এটির নাম রেখে থাকেন।
বদলে insert বা append ব্যবহার করুন।