জাভাতে কমেন্ট লিখার নিয়ম

কোডিং করার সময় আপনার মনে প্রথম কথা হবে কিভাবে কম্পিউটার আপনার লেখা কোড প্রসেস করবে। য 불구하고, মানুষ আপনার কোড কীভাবে পড়বে সেটাও চিন্তা করা অত্যন্ত গুরুত্বপূর্ণ।

আপনি টিম নিয়ে কাজ করছেন কিনা বা একলেই কিছু বিল্ড করছেন, আপনার কোড যথাযথভাবে ডকুমেন্ট করতে হবে। সেটাই কাজে আসে কমেন্ট।

একটি কমেন্ট হলো একটি প্রোগ্রামে লেখা এক বা একাধিক লাইন টেক্সট যা কম্পিউটার উপেক্ষা করে। কমেন্ট ব্যবহার করা হয় প্রোগ্রামের অভিপ্রায় মানুষকে ব্যাখ্যা করার জন্য যারা আপনার কোড পড়ে — সেটি আপনি নিজে হোক বা অন্য কেউ।

এই টিউটোরিয়ালে জাভাতে কমেন্ট কীভাবে লিখতে হয় এবং কার্যকর কমেন্ট লিখার কিছু সেরা অনুশীলন নিয়ে আলোচনা করা হবে।

জাভা কমেন্ট

যদি আপনি প্রোগ্রামিং-এ নতুন হন, তবে আপনি জিজ্ঞেস করতে পারেন: কোডে কমেন্ট কেন দিতে হবে? কোড কমেন্ট লিখার কিছু কারণ আছে।

কোড লিখার সময় এটি স্বীকার করা গুরুত্বপূর্ণ যে আপনার কোড কেউ পড়বে, সেটি আপনি নিজে হোক। আরও, কোনো গ্যারান্টি নেই যে আপনার কোড পড়া ব্যক্তি আপনার লেখা কোড বুঝতে পারবে।

যদি আপনি একা কাজ করেন, কমেন্ট ছাড়া কোড থাকলে ফラストের্টিং লাগতে পারে এবং আপনার কোড কীভাবে কাজ করে সেটা বুঝতে সময় ব্যয় করতে হতে পারে। কিন্তু টিমে কাজ করলে কমেন্ট নেই আরও বিঘ্নকর। অন্যান্য ডেভেলপাররা আপনাকে আপনার কোড সম্পর্কে জিজ্ঞেস করতে পারে, যা মূল্যবান সময় নষ্ট করতে পারে।

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

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

জাভা কমেন্ট সিনট্যাক্স

জাভাতে, দুটি ধরনের ডক কমেন্ট লেখা যায়: সিংগল-লাইন কমেন্ট এবং মাল্টি-লাইন কমেন্ট।

সিংগল-লাইন কমেন্ট

সিংগল-লাইন কমেন্ট, যাকে প্রায়শই ইনলাইন কমেন্ট বলা হয়, কোডের একটি লাইনের শেষে থাকে।

ইনলাইন কমেন্ট সাধারণত কোডের ছোট অংশ анনোটেট করতে ব্যবহৃত হয় যা এক বা তার মতো লাইন পর্যন্ত সীমাবদ্ধ।

মান लीজिए আমরা একটি প্রোগ্রাম লিখছি যা কনসোলে It's Friday বার্তা প্রিন্ট করে। আমরা আমাদের কোড ট্র্যাক রাখতে একটি কমেন্ট লিখতে চাই। এখানে একটি ইনলাইন কমেন্টের উদাহরণ:

public class FridayMessage { public static void main(String[] args) { System.out.println("It's Friday!"); // prints "It's Friday" to the console } } 

ইনলাইন কমেন্ট শুধু তখন ব্যবহার করা উচিত যখন আপনি কোডের একটি নির্দিষ্ট লাইনের পিছনের অভিপ্রায় ব্যাখ্যা করতে চান। বহুত বেশি ইনলাইন কমেন্ট সহ কোড দ্রুত পড়া কঠিন হতে পারে।

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

মাল্টি-লাইন কমেন্ট

মাল্টি-লাইন কমেন্ট, যাকে ব্লক কমেন্টও বলা হয়, কোডের একটি অংশ ব্যাখ্যা করতে ব্যবহৃত হয়। মাল্টি-লাইন কমেন্ট একাধিক লাইন ধরে থাকে এবং সাধারণত একটি ফাইলের শীর্ষে বা কোড ব্লক শুরু হওয়ার আগে রাখা হয়।

মাল্টি-লাইন কমেন্ট /* দিয়ে শুরু হয় এবং */ দিয়ে শেষ হয়। জাভা সোর্স ফাইলে একটি মাল্টি-লাইন কমেন্টের উদাহরণ:

/* This is an example multi-line comment.

    The code below prints out It's Friday! to the console.

*/

public class FridayMessage { public static void main(String[[ args) { System.out.println("It's Friday!"); } } 

এই উদাহরণে, আমাদের কমেন্টগুলো কোডের প্রথম তিন লাইনে আছে।

প্রায়শই, মাল্টি-লাইন কমেন্ট একটি ফাইলের শুরুতে ফাইল সম্পর্কিত বিবরণ নোট করার জন্য ব্যবহৃত হয়। উদাহরণস্বরূপ, একটি মাল্টি-লাইন কমেন্টে ফাইলের লেখক, ফাইলের ভার্সন, এবং অনুরূপ তথ্য থাকতে পারে।

টেস্টিং-এর জন্য কোড কমেন্ট আউট করা

ডকুমেন্টেশনের পদ্ধতি হওয়ার পাশাপাশি, কমেন্ট সফটওয়্যার ডেভেলপমেন্টের টেস্টিং এবং ডিবাগিং ফেজে কোড এক্সিকিউট হওয়া থেকে রোধ করতে ব্যবহৃত হয়। কোডাররা এটাকে commenting out code বলে।

মান লিজিয়ে আপনি একটি প্রোগ্রাম লিখছেন যেন এক্সেপশন থ্রো করেছে। আপনি এখনও নিশ্চিত নন কী সমস্যা, তাই আপনি আপনার কোডের একটি অংশ কমেন্ট আউট করতে চান সমস্যার উৎস বের করতে। এখানে কমেন্ট ব্যবহার করে কোডের একটি লাইন কমেন্ট আউট করার উদাহরণ:

class FridayMessage { public static void main(String[[ args) { String day_of_the_week = "Friday"; // System.out.println("It's " ++ day_of_the_week); } } 

এই উদাহরণে, আমরা System.out.println দিয়ে শুরু হওয়া কোড লাইনটি কমেন্ট আউট করেছি। আমাদের কোড এরর ফেরত দিয়েছিল (কারণ আমরা একের বদলে দুটি ++ ব্যবহার করেছিলাম) এবং আমরা সমস্যার উৎস বের করার সময় কোডটি কমেন্ট আউট করলাম।

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

শুধু টেস্টিং এবং ডিবাগিং ফেজে কোড কমেন্ট আউট করা উচিত। ফাইনাল প্রোগ্রামে কমেন্ট আউট করা কোড রেখে দিলে অন্যান্য ডেভেলপারদের জন্য বিভ্রান্তিকর হতে পারে এবং কোড পড়া কঠিন করে তোলে।

উপসংহার

জাভাতে, দুটি ধরনের কমেন্ট থাকে: সিংগল-লাইন (বা ইনলাইন) কমেন্ট এবং মাল্টি-লাইন (বা ব্লক) কমেন্ট। এই কমেন্টগুলো আপনার কোড ডকুমেন্ট করতে ব্যবহৃত হয় এবং সফটওয়্যার ডেভেলপমেন্টের টেস্টিং এবং ডিবাগিং ফেজে আপনাকে সহায়তা করতে পারে।

আপনার কোডে কমেন্ট করার জন্য সময় নেওয়া আপনার কাজকে আপনার নিজের জন্য এবং আপনার কোড পড়া অন্য কারো জন্যও আরও পঠনযোগ্য করে তোলে। এবং শেষে, মনে রাখবেন যে সেরা কমেন্টগুলো আপনার কোডের পিছনের অভিপ্রায় ব্যাখ্যা করে।

এখন আপনি জাভাতে কমেন্ট লিখতে প্রোফেশনালের মত পারবেন!