কমেন্ট বা ডকুমেন্টেশন যেকোন প্রোগামকে সবার কাছে বোধগম্য করতে সাহায্য করে। ধরা যাক আমরা বিশাল বড় একটা প্রোগ্রাম লিখ ফেললাম বা একটা সফটওয়্যার বানিয়ে ফেললাম। কেউ যদি ঐ কোডটি দেখে তাহলে না বুঝতে পারাটাই স্বাভাবিক। তাই সবচেয়ে ভাল প্র্যাকটিস হল কোডে যথেষ্ট পরিমানে কমেন্ট ব্যবহার করা, সম্ভব হলে ডকুমেন্টেশন রাখা। এখানে আমরা পাইথনের কমেন্টিং এবং ডকুমেন্টেশন সম্পর্কে জেনে নেব।
কমেন্ট (Comment)
কোডে কমেন্ট করা হয় সাধারণত কোন কিছু টুকে রাখার জন্য, অথবা কোন ফাংশন বা ভেরিয়েবল কি কাজে ব্যবহার করা হয়েছে সেটা লিখে রাখার জন্য। গত পর্বে আমরা Hello World এর একটা কোড লিখেছিলাম, কোডটি এখানে আবার পুনরাবৃত্তি করি –
print("Hello World")
যেহেতু এটা খুবই ছোট একটা কোড, সেহেতু এখানে কমেন্ট ব্যবহার না করলেও চলে। কিন্তু যদি বড় কোড হয় তাহলে? চলুন এই কোডটাই একটু কমেন্ট ব্যবহার করে লিখি-
#This code is to display "Hello World" in console
print("Hello World")
উপরের কোডটি আগের মত একই ফলাফল দেখাবে। কিন্তু এখানে একজন নতুন প্রোগ্রামার খুব সহজেই বুঝতে পারবে যে এই প্রোগ্রামটা দিয়ে করা হয়েছে।
পাইথনে এক লাইনের কমেন্টের জন্য ঐ লাইনের সামনে একটা # চিহ্ন বসিয়ে দিলেই হয়। অর্থাৎ কোন স্টেটমেন্ট (Statement) এর আগে # থাকলে সেটা কমেন্ট হিসেবে গণ্য হবে এবং এটা মূল প্রোগ্রামের আউটপুট হিসেবে প্রদর্শিত হবে না।
ধরা যাক আরো কয়েক লাইনের কমেন্ট করার দরকার, তাহলে? আমরা প্রতি লাইনের সামনে # চিহ্ন দিয়ে এটা করতে পারি। তবে পাইথনে এর আরেকটু সহজ সমাধান আছে। নিচের কোডটি দেখে নেওয়া যাক –
"""
Created on Fri Jun 21 18:13:18 2019
@author: SHAHINUR
"""
#This code is to display "Hello World" in console
print("Hello World")
এটার ফলাফলও কিন্তু আগের মত একই Hello World হবে; কিন্তু এখানে আমরা কোডে আমার নাম ও তারিখ দিয়ে দিয়েছি, অর্থাৎ একাধিক লাইনকে কমেন্ট এ রেখেছি। একাধিক লাইনের কমেন্টের জন্য “”” এই চিহ্ন দিয়ে শুরু করে “”” এই চিহ্ন দিয়ে শেষ করতে হয়।
মূলকথাঃ # দিয়ে এক লাইনের কমেন্ট এবং “”” চিহ্ন দিয়ে একাধিক লাইনের কমেন্ট করা হয়।